royw-tmdb 0.1.0 → 0.1.1

data/VERSION.yml

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

data/lib/string_extensions.rb

@@ -8,6 +8,14 @@ class String
     end
   end
 
+  # this handles unicode characters by converting each byte to "%XX"
+  # where XX is the hex value
+  my_extension("escape_unicode") do
+    def escape_unicode
+      self.each_byte.collect{|c| c.to_i > 127 ? "%#{c.to_i.to_s(16)}" : c.chr}.join('')
+    end
+  end
+
   my_extension("strip_tags") do
     def strip_tags
       gsub(/<\/?[^>]*>/, "")

data/lib/tmdb.rb

@@ -8,6 +8,7 @@ require 'xmlsimple'
 
 require 'tmdb/optional_logger'
 require 'tmdb/tmdb_movie'
+require 'tmdb/tmdb_image'
 require 'tmdb/tmdb_profile'
 require 'module_extensions'
 require 'string_extensions'

data/lib/tmdb/optional_logger.rb

@@ -9,23 +9,35 @@ class OptionalLogger
   end
 
   # debug {...}
-  def debug(&blk)
-    @logger.debug(blk.call) unless @logger.nil?
+  def debug(msg=nil, &blk)
+    unless @logger.nil?
+      @logger.debug(msg) unless msg.nil?
+      @logger.debug(blk.call) unless blk.nil?
+    end
   end
 
   # info {...}
-  def info(&blk)
-    @logger.info(blk.call) unless @logger.nil?
+  def info(msg=nil, &blk)
+    unless @logger.nil?
+      @logger.info(msg) unless msg.nil?
+      @logger.info(blk.call) unless blk.nil?
+    end
   end
 
   # warn {...}
-  def warn(&blk)
-    @logger.warn(blk.call) unless @logger.nil?
+  def warn(msg=nil, &blk)
+    unless @logger.nil?
+      @logger.warn(msg) unless msg.nil?
+      @logger.warn(blk.call) unless blk.nil?
+    end
   end
 
   # error {...}
-  def error(&blk)
-    @logger.error(blk.call) unless @logger.nil?
+  def error(msg=nil, &blk)
+    unless @logger.nil?
+      @logger.error(msg) unless msg.nil?
+      @logger.error(blk.call) unless blk.nil?
+    end
   end
 end
 

data/lib/tmdb/tmdb_image.rb

@@ -0,0 +1,155 @@
+class TmdbImage
+  attr_reader :imdb_id
+
+  # imdb_id => String IMDB ID either with or without the 'tt' prefix
+  # api_key => String containing the themovieDb.com API key
+  # logger => nil or logger instance
+  def initialize(imdb_id, api_key, logger)
+    @imdb_id = imdb_id
+    @api_key = api_key
+    @logger = OptionalLogger.new(logger)
+  end
+
+  # return an Array of fanart sizes as Strings
+  def fanart_sizes
+    ['original', 'mid', 'thumb']
+  end
+
+  # return an Array of poster sizes as Strings
+  def poster_sizes
+    ['original', 'mid', 'thumb', 'cover']
+  end
+
+  # return nil or the source url to the given size (must be in fanart_sizes) fanart
+  # optionally save the image to dest_filespec unless dest_filespec is nil
+  def fanart(size, dest_filespec=nil)
+    src_url = nil
+    if fanart_sizes.include?(size)
+      src_url = image_url(@imdb_id, 'fanarts', size)
+      copy_image(src_url, dest_filespec) unless dest_filespec.nil?
+    end
+    src_url
+  end
+
+  # return nil or the source url to the given size (must be in poster_sizes) poster
+  # optionally save the image to dest_filespec unless dest_filespec is nil
+  def poster(size, dest_filespec=nil)
+    src_url = nil
+    if poster_sizes.include?(size)
+      src_url = image_url(@imdb_id, 'posters', size)
+      copy_image(src_url, dest_filespec) unless dest_filespec.nil?
+    end
+    src_url
+  end
+
+  # return nil or the source url to the 'original' size fanart
+  # optionally save the image to dest_filespec unless dest_filespec is nil
+  def fanart_original(dest_filespec=nil)
+    fanart('original', dest_filespec)
+  end
+
+  # return nil or the source url to the 'mid' size fanart
+  # optionally save the image to dest_filespec unless dest_filespec is nil
+  def fanart_mid(dest_filespec=nil)
+    fanart('mid', dest_filespec)
+  end
+
+  # return nil or the source url to the 'thumb' size fanart
+  # optionally save the image to dest_filespec unless dest_filespec is nil
+  def fanart_thumb(dest_filespec=nil)
+    fanart('thumb', dest_filespec)
+  end
+
+  # return nil or the source url to the 'original' size poster
+  # optionally save the image to dest_filespec unless dest_filespec is nil
+  def poster_original(dest_filespec=nil)
+    poster('original', dest_filespec)
+  end
+
+  # return nil or the source url to the 'mid' size poster
+  # optionally save the image to dest_filespec unless dest_filespec is nil
+  def poster_mid(dest_filespec=nil)
+    poster('original', dest_filespec)
+  end
+
+  # return nil or the source url to the 'thumb' size poster
+  # optionally save the image to dest_filespec unless dest_filespec is nil
+  def poster_thumb(dest_filespec=nil)
+    poster('original', dest_filespec)
+  end
+
+  # return nil or the source url to the 'cover' size poster
+  # optionally save the image to dest_filespec unless dest_filespec is nil
+  def poster_cover(dest_filespec=nil)
+    poster('original', dest_filespec)
+  end
+
+  protected
+
+  # find the URL to the image
+  # imdb_id => IMDB ID with or without 'tt' prefix
+  # type => either 'fanart' or 'poster' String
+  # size => member of either fanart_sizes or poster_sizes
+  def image_url(imdb_id, type, size)
+    src_url = nil
+    profile = TmdbProfile.first(:imdb_id => imdb_id, :api_key => @api_key, :filespec => nil, :logger => @logger)
+    indexes = {}
+    unless profile.nil? || profile.movie.blank?
+      movie = profile.movie
+      unless movie[type].blank?
+        images = movie[type]
+        images.each do |image|
+          if image['size'] == size
+            @logger.debug { "#{image.inspect}" }
+            src_url = image['content']
+          end
+        end
+      end
+    end
+    src_url
+  end
+
+  # download the fanart
+  def copy_image(src_url, dest_filespec)
+    begin
+      extension = File.extname(src_url)
+      unless extension.blank?
+        dest_filespec += extension
+      end
+      data = fetch(src_url.escape_unicode)
+      File.open(dest_filespec, 'w') do |file|
+        file.print(data)
+      end
+    rescue Exception => e
+      @logger.error { "Error fetching image.\n  src_url => #{src_url},\n  dest_filespec => #{dest_filespec}\n  #{e.to_s}" }
+    end
+  end
+
+  MAX_ATTEMPTS = 3
+  SECONDS_BETWEEN_RETRIES = 1.0
+
+  # fetch the page retrying on error up to MAX_ATTEMPTS with a pause
+  # of SECONDS_BETWEEN_RETRIES seconds between retries
+  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
+
+  # makes reading from cache during specs possible
+  def read_page(src_url)
+    open(src_url).read
+  end
+
+end

data/lib/tmdb/tmdb_movie.rb

@@ -2,9 +2,15 @@ class TmdbMovie
 
   attr_reader :query, :document
 
-  def initialize(ident, key)
+  def initialize(ident, key, logger)
     @imdb_id = 'tt' + ident.gsub(/^tt/, '') unless ident.blank?
+    @api_key = key
     @query = "http://api.themoviedb.org/2.0/Movie.imdbLookup?imdb_id=#{@imdb_id}&api_key=#{key}"
+    @logger = OptionalLogger.new(logger)
+  end
+
+  def image
+    TmdbImage.new(@imdb_id, @api_key, @logger)
   end
 
   def fanarts
@@ -100,7 +106,7 @@ class TmdbMovie
     # Fetch the document with retry to handle the occasional glitches
   def document
     if @document.nil?
-      html = fetch(self.query)
+      html = fetch(self.query.escape_unicode)
       @document = XmlSimple.xml_in(html)
       @document = nil if @document['totalResults'] == ['0']
     end

data/lib/tmdb/tmdb_profile.rb

@@ -49,6 +49,8 @@ class TmdbProfile
 
   attr_reader :imdb_id, :movie
 
+  # convert to xml
+  # returns String (either empty or containing the xml)
   def to_xml
     xml = ''
     unless @movie.blank?
@@ -58,6 +60,11 @@ class TmdbProfile
     xml
   end
 
+  # return the TmdbImage for this profile
+  def image
+    TmdbImage.new(@imdb_id.gsub(/^tt/, ''), @api_key, @logger)
+  end
+
   protected
 
   def load
@@ -67,7 +74,7 @@ class TmdbProfile
       @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/, ''), @api_key).to_hash
+      @movie = TmdbMovie.new(@imdb_id.gsub(/^tt/, ''), @api_key, @logger).to_hash
       save(@filespec) unless @filespec.blank?
     end
     unless @movie.blank?

data/spec/tmdb_image_spec.rb

@@ -0,0 +1,118 @@
+require 'spec_helper'
+require 'tempfile'
+
+require 'ruby-debug'
+
+# Time to add your specs!
+# http://rspec.info/
+
+TMDB_API_KEY = '7a2f6eb9b6aa01651000f0a9324db835'
+
+describe "TmdbImage" do
+
+  before(:all) do
+    @logger = nil
+    File.mkdirs(TMPDIR)
+  end
+
+  before(:each) do
+    # tt0465234 => National Treasure: Book of Secrets
+    @image = TmdbImage.new('tt0465234', TMDB_API_KEY, @logger)
+  end
+
+  after(:each) do
+    Dir.glob(File.join(TMPDIR,'tmdb_image_spec*')).each { |filename| File.delete(filename) }
+  end
+
+  it "should find by imdb_id" do
+    @image.should_not == nil
+  end
+
+  it "should find image via profile" do
+    profile = TmdbProfile.first(:imdb_id => 'tt0465234', :api_key => TMDB_API_KEY, :logger => @logger)
+    profile.image.imdb_id.should == '0465234'
+  end
+
+  it "should find image via movie" do
+    profile = TmdbMovie.new('tt0465234', TMDB_API_KEY, @logger)
+    profile.image.imdb_id.should == 'tt0465234'
+  end
+
+  it "should find original size fanart" do
+    src_url = nil
+    src_url = @image.fanart_original unless @image.nil?
+    src_url.should_not be_nil
+  end
+
+  it "should find mid size fanart" do
+    src_url = nil
+    src_url = @image.fanart_mid unless @image.nil?
+    src_url.should_not be_nil
+  end
+
+  it "should find thumb size fanart" do
+    src_url = nil
+    src_url = @image.fanart_thumb unless @image.nil?
+    src_url.should_not be_nil
+  end
+
+  it "should find original size poster" do
+    src_url = nil
+    src_url = @image.poster_original unless @image.nil?
+    src_url.should_not be_nil
+  end
+
+  it "should find mid size poster" do
+    src_url = nil
+    src_url = @image.poster_mid unless @image.nil?
+    src_url.should_not be_nil
+  end
+
+  it "should find thumb size poster" do
+    src_url = nil
+    src_url = @image.poster_thumb unless @image.nil?
+    src_url.should_not be_nil
+  end
+
+  it "should find cover size poster" do
+    src_url = nil
+    src_url = @image.poster_cover unless @image.nil?
+    src_url.should_not be_nil
+  end
+
+  it "should find all fanarts" do
+    buf = []
+    @image.fanart_sizes.each do |size|
+      buf << "fanart(#{size}) returned nil" if @image.fanart(size).nil?
+    end
+    puts buf.join("\n") unless buf.empty?
+    buf.empty?.should be_true
+  end
+
+  it "should find all posters" do
+    buf = []
+    @image.poster_sizes.each do |size|
+      buf << "poster(#{size}) returned nil" if @image.poster(size).nil?
+    end
+    puts buf.join("\n") unless buf.empty?
+    buf.empty?.should be_true
+  end
+
+  # the same routine is used by all the getters to fetch the image so only
+  # need to test one case
+  it "should fetch fanart" do
+    filespec = get_temp_filename
+    src_url = @image.fanart_original(filespec)
+    filespec += File.extname(src_url)
+    (File.exist?(filespec).should be_true) && (File.size(filespec).should > 0)
+  end
+
+  def get_temp_filename
+    outfile = Tempfile.new('tmdb_image_spec', TMPDIR)
+    filespec = outfile.path
+    outfile.unlink
+    filespec
+  end
+
+end
+

data/spec/tmdb_movie_spec.rb

@@ -8,11 +8,12 @@ TMDB_API_KEY = '7a2f6eb9b6aa01651000f0a9324db835'
 describe "TmdbMovie" do
 
   before(:all) do
+    @logger = nil
     File.mkdirs(TMPDIR)
   end
 
   before(:each) do
-    @profile = TmdbMovie.new('tt0465234', TMDB_API_KEY)
+    @profile = TmdbMovie.new('tt0465234', TMDB_API_KEY, @logger)
   end
 
   after(:each) do
@@ -68,7 +69,7 @@ describe "TmdbMovie" do
   end
 
   it "should handle The Sand Pebble" do
-    profile = TmdbMovie.new('tt0060934', TMDB_API_KEY)
+    profile = TmdbMovie.new('tt0060934', TMDB_API_KEY, @logger)
     profile.idents.should be_nil
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: royw-tmdb
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Roy Wright
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-17 00:00:00 -07:00
+date: 2009-04-18 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -33,10 +33,12 @@ files:
 - lib/string_extensions.rb
 - lib/tmdb.rb
 - lib/tmdb/optional_logger.rb
+- lib/tmdb/tmdb_image.rb
 - lib/tmdb/tmdb_movie.rb
 - lib/tmdb/tmdb_profile.rb
 - spec/cache_extensions.rb
 - spec/spec_helper.rb
+- spec/tmdb_image_spec.rb
 - spec/tmdb_movie_spec.rb
 - spec/tmdb_profile_spec.rb
 has_rdoc: true
@@ -70,3 +72,4 @@ test_files:
 - spec/tmdb_profile_spec.rb
 - spec/spec_helper.rb
 - spec/tmdb_movie_spec.rb
+- spec/tmdb_image_spec.rb