royw-dvdprofiler2xbmc 0.0.5 → 0.0.6

data/.gitignore

@@ -0,0 +1,8 @@
+*~
+/pkg
+/spec/samples/www.imdb.com
+Announcement
+script/
+spec/samples/Collection.yaml
+test/
+

data/History.txt

@@ -1,4 +1,9 @@
+== 0.0.6 2009-04-08
+    added support for tmdb
+    added caching lookup data with movie (performance boost)
+    added specs which cache online lookups (first time slow, afterwards very fast)
 
+== 0.0.4
     ignore file backups and generated content
     tab cleanup and added Music => Musical default genre mapping
     tab cleanup

data/Manifest.txt

@@ -1,3 +1,4 @@
+.gitignore
 History.txt
 Manifest.txt
 PostInstall.txt
@@ -6,11 +7,37 @@ Rakefile
 bin/dvdprofiler2xbmc
 dvdprofiler2xbmc.gemspec
 lib/dvdprofiler2xbmc.rb
-lib/dvdprofiler2xbmc/app.rb
 lib/dvdprofiler2xbmc/app_config.rb
-lib/dvdprofiler2xbmc/cli.rb
-lib/dvdprofiler2xbmc/collection.rb
+lib/dvdprofiler2xbmc/controllers/app.rb
+lib/dvdprofiler2xbmc/controllers/fanart_controller.rb
+lib/dvdprofiler2xbmc/controllers/nfo_controller.rb
+lib/dvdprofiler2xbmc/controllers/thumbnail_controller.rb
 lib/dvdprofiler2xbmc/extensions.rb
-lib/dvdprofiler2xbmc/media.rb
-lib/dvdprofiler2xbmc/media_files.rb
-lib/dvdprofiler2xbmc/nfo.rb
+lib/dvdprofiler2xbmc/models/collection.rb
+lib/dvdprofiler2xbmc/models/dvdprofiler_profile.rb
+lib/dvdprofiler2xbmc/models/imdb_profile.rb
+lib/dvdprofiler2xbmc/models/media.rb
+lib/dvdprofiler2xbmc/models/media_files.rb
+lib/dvdprofiler2xbmc/models/tmdb_movie.rb
+lib/dvdprofiler2xbmc/models/tmdb_profile.rb
+lib/dvdprofiler2xbmc/models/xbmc_info.rb
+lib/dvdprofiler2xbmc/open_cache_extension.rb
+lib/dvdprofiler2xbmc/views/cli.rb
+spec/cache_extensions.rb
+spec/dvdprofiler2xbmc_spec.rb
+spec/dvdprofiler_profile_spec.rb
+spec/imdb_profile_spec.rb
+spec/nfo_controller_spec.rb
+spec/samples/Collection.xml
+spec/samples/Collection.yaml
+spec/samples/Die Hard - 1988.nfo
+spec/samples/The Egg and I.dummy
+spec/spec.opts
+spec/spec_helper.rb
+spec/tmdb_movie_spec.rb
+spec/tmdb_profile_spec.rb
+spec/xbmc_info_spec.rb
+tasks/rspec.rake
+test/test_dvdprofiler2xbmc.rb
+test/test_dvdprofiler2xbmc_cli.rb
+test/test_helper.rb

data/PostInstall.txt

@@ -1,7 +1,58 @@
+First check the version by running:
 
-For more information on dvdprofiler2xbmc, see http://dvdprofiler2xbmc.rubyforge.org
+ $ bin/dvdprofiler2xbmc -v
+ INFO dvdprofiler2xbmc: Dvdprofiler2xbmc 0.0.4
+ INFO dvdprofiler2xbmc: saving: /home/royw/.dvdprofiler2xbmcrc
 
-NOTE: Change this information in PostInstall.txt 
-You can also delete it if you don't want it.
+Notice that this generated a config file for you
+(/home/royw/.dvdprofiler2xbmcrc) in your home directory.
 
+Now edit the config file.  Be sure to change the following fields to match
+your system:
+
+  collection_filespec: /home/royw/DVD Profiler/Shared/Collection.xml
+  images_dir: /home/royw/DVD Profiler/Shared/Images
+  directories:
+  - /media/dad-kubuntu/public/data/videos_iso
+  - /media/dcerouter/public/data/videos_iso
+  - /media/royw-gentoo/public/data/videos_iso
+  - /media/royw-gentoo/public/data/movies
+  genre_maps: !map:Mash
+    Anime: Animation
+    Science-Fiction: Science Fiction
+    SciFi: Science Fiction
+    Musical: Musicals
+
+The "collection_filespec" points to the collection.xml file exported by
+DVD Profiler.
+
+The "images_dir" points to the directory containing the images (cover scans)
+from DVD Profiler.
+
+The "directories" are the top level directories of where your media is
+stored.  Note, may be mount points or symbolic links.
+
+The "genre_maps" is a list of genres to rename.  In the above example,
+"Anime" will be renamed "Animation", "Science-Fiction" will be renamed
+"Science Fiction", etc.
+
+You may want to adjust these also:
+
+  file_permissions: 436
+  dir_permissions: 511
+
+Note the permissions are the base 10 integer of the octal permission mask.
+For example, 436 (base 10) is 664 (base 8) and 511 (base 10) is 777 (base 8).
+
+Save the .dvdprofiler2xbmcrc file.
+
+You may want to get the command line help by running:
+
+  dvdprofiler2xbmc --help
+
+To process your media, simply run:
+
+  dvdprofiler2xbmc
+
+For more information on dvdprofiler2xbmc, see http://www/github.com/royw/dvdprofiler2xbmc
 

data/README.rdoc

@@ -5,14 +5,11 @@
 == STATUS
 
 The initial goal of using DVD Profiler data when available along
-with IMDB data otherwise is just about met.  There is still some
-performance issues mainly related to using the production or
-released years to refine searches that have multiple title matches.
+with IMDB data otherwise is met.
 
 Near term plans include:
 * supporting multiple file matching patterns
 * supporting directory containers
-* interfacing to TMDb, primarily for fanart.
 
 == DESCRIPTION:
 
@@ -20,12 +17,35 @@ This script will attempt to match up media files from a set of directories
 to the collection.xml file exported from DVD Profiler.  For matches, the
 script will then create a {moviename}.nfo from the data in collections.xml
 and also copy the front cover image to {moviename}.tbn.  Both files will
-be placed in the same directory as the source media file.
+be placed in the same directory as the source media file.  Also the specific
+profile information for each movie will be saved into
+{moviename}.dvdprofiler.xml.
 
-Then on XBMC, set the source content to none to remove the meta data from
-the library, then set the source content back to Movies to import the
-media.  This time, the data in the .nfo files will be used instead of
-scraping.
+The script will then search IMDB for a title or also known as (AKA) match.
+If necessary, the script will refine the search by using the media year
+(year in media filename), then dvdprofiler production year, then dvdprofiler
+release year, then try again with each year plus or minus a year.  The IMDB
+profile found will be saved as {moviename}.imdb.xml.
+
+Next the script will use the IMDB ID to query themovieDb.com.  This is
+primarily to retrieve any fanart but will also add any missing parameters
+to the .nfo file (very unlikely).  The TMDB profile found will be saved as
+{moviename}.tmdb.xml.
+
+So in summary the files generated are:
+
+{moviename}.tmdb.xml        - profile from themovieDb.com
+{moviename}.imdb.xml        - profile from imdb.com
+{moviename}.dvdprofiler.xml - profile from collection.xml
+{moviename}-fanart.jpg      - first fanart image from themovieDb.com
+{moviename}.tbn             - image from DVD Profiler
+{moviename}.nfo             - generated info profile for xbmc
+
+To force regeneration, simply delete these files then run the script again.
+
+Then on XBMC, set the source content to none to remove the meta data from the
+library, then set the source content back to Movies to import the media.
+This time, the data in the .nfo files will be used instead of scraping.
 
 == NOTES:
 
@@ -45,12 +65,19 @@ include these in the title.
 
 Features:
 
-* Creates .nfo files from exported collection.xml from DVD Profiler
+* Creates .nfo files from exported collection.xml from DVD Profiler and
+  imdb.com.
 * If .nfo does not have an <id> tag, then tries to find the IMDB ID by
   using the title and production/release years to search IMDB.
 * Sets file permissions for files and directories
 * Media can be contained in a set of directories (they can be mount points)
 * Adds sub-directory names as genres to .nfo files
+* To prevent reporting missing ISBN, "touch {moviename}.no_isbn" (this is
+  useful to ignore boxed sets)
+* To prevent lookup on imdb, "touch {moviename}.no_imdb_lookup" (this is
+  useful for titles you know are not on imdb.com)
+* To prevent lookup on tmdb, "touch {moviename}.no_tmdb_lookup" (this is
+  useful for titles you know are not on themovieDb.com)
 
 Problems:
 
@@ -127,7 +154,7 @@ To process your media, simply run:
 
 * ruby 1.8.x
 * rubygem
-* my imdb fork on github (gem install )
+* my imdb fork on github (sudo gem install royw-imdb)
 
 == INSTALL:
 

data/Rakefile

@@ -11,7 +11,7 @@ $hoe = Hoe.new('dvdprofiler2xbmc', Dvdprofiler2xbmc::VERSION) do |p|
   p.extra_deps         = [
     ['activesupport','>= 2.0.2'],
     ['xml-simple','>= 1.0.12'],
-    ['royw-imdb','>= 0.0.8'],
+    ['royw-imdb','>= 0.0.16'],
     ['log4r','>= 1.0.5'],
     ['commandline','>= 0.7.10'],
     ['mash','>= 0.0.3']

data/bin/dvdprofiler2xbmc

@@ -5,6 +5,6 @@
 
 require File.expand_path(File.dirname(__FILE__) + "/../lib/dvdprofiler2xbmc")
 
-require "dvdprofiler2xbmc/cli"
+require "dvdprofiler2xbmc/views/cli"
 
 Dvdprofiler2xbmc::CLI.execute(STDOUT, ARGV)

data/dvdprofiler2xbmc.gemspec

@@ -2,17 +2,17 @@
 
 Gem::Specification.new do |s|
   s.name = %q{dvdprofiler2xbmc}
-  s.version = "0.0.5"
+  s.version = "0.0.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Roy Wright"]
-  s.date = %q{2009-03-30}
+  s.date = %q{2009-04-08}
   s.default_executable = %q{dvdprofiler2xbmc}
-  s.description = %q{This script will attempt to match up media files from a set of directories to the collection.xml file exported from DVD Profiler.  For matches, the script will then create a {moviename}.nfo from the data in collections.xml and also copy the front cover image to {moviename}.tbn.  Both files will be placed in the same directory as the source media file.  Then on XBMC, set the source content to none to remove the meta data from the library, then set the source content back to Movies to import the media.  This time, the data in the .nfo files will be used instead of scraping.}
+  s.description = %q{This script will attempt to match up media files from a set of directories to the collection.xml file exported from DVD Profiler.  For matches, the script will then create a {moviename}.nfo from the data in collections.xml and also copy the front cover image to {moviename}.tbn.  Both files will be placed in the same directory as the source media file.  Also the specific profile information for each movie will be saved into {moviename}.dvdprofiler.xml.  The script will then search IMDB for a title or also known as (AKA) match. If necessary, the script will refine the search by using the media year (year in media filename), then dvdprofiler production year, then dvdprofiler release year, then try again with each year plus or minus a year.  The IMDB profile found will be saved as {moviename}.imdb.xml.  Next the script will use the IMDB ID to query themovieDb.com.  This is primarily to retrieve any fanart but will also add any missing parameters to the .nfo file (very unlikely).  The TMDB profile found will be saved as {moviename}.tmdb.xml.  So in summary the files generated are:  {moviename}.tmdb.xml        - profile from themovieDb.com {moviename}.imdb.xml        - profile from imdb.com {moviename}.dvdprofiler.xml - profile from collection.xml {moviename}-fanart.jpg      - first fanart image from themovieDb.com {moviename}.tbn             - image from DVD Profiler {moviename}.nfo             - generated info profile for xbmc  To force regeneration, simply delete these files then run the script again.  Then on XBMC, set the source content to none to remove the meta data from the library, then set the source content back to Movies to import the media. This time, the data in the .nfo files will be used instead of scraping.}
   s.email = ["roy@wright.org"]
   s.executables = ["dvdprofiler2xbmc"]
   s.extra_rdoc_files = ["History.txt", "Manifest.txt", "PostInstall.txt", "README.rdoc"]
-  s.files = ["History.txt", "Manifest.txt", "PostInstall.txt", "README.rdoc", "Rakefile", "bin/dvdprofiler2xbmc", "dvdprofiler2xbmc.gemspec", "lib/dvdprofiler2xbmc.rb", "lib/dvdprofiler2xbmc/app.rb", "lib/dvdprofiler2xbmc/app_config.rb", "lib/dvdprofiler2xbmc/cli.rb", "lib/dvdprofiler2xbmc/collection.rb", "lib/dvdprofiler2xbmc/extensions.rb", "lib/dvdprofiler2xbmc/media.rb", "lib/dvdprofiler2xbmc/media_files.rb", "lib/dvdprofiler2xbmc/nfo.rb", "test/test_dvdprofiler2xbmc.rb", "test/test_helper.rb", "test/test_dvdprofiler2xbmc_cli.rb"]
+  s.files = [".gitignore", "History.txt", "Manifest.txt", "PostInstall.txt", "README.rdoc", "Rakefile", "bin/dvdprofiler2xbmc", "dvdprofiler2xbmc.gemspec", "lib/dvdprofiler2xbmc.rb", "lib/dvdprofiler2xbmc/app_config.rb", "lib/dvdprofiler2xbmc/controllers/app.rb", "lib/dvdprofiler2xbmc/controllers/fanart_controller.rb", "lib/dvdprofiler2xbmc/controllers/nfo_controller.rb", "lib/dvdprofiler2xbmc/controllers/thumbnail_controller.rb", "lib/dvdprofiler2xbmc/extensions.rb", "lib/dvdprofiler2xbmc/models/collection.rb", "lib/dvdprofiler2xbmc/models/dvdprofiler_profile.rb", "lib/dvdprofiler2xbmc/models/imdb_profile.rb", "lib/dvdprofiler2xbmc/models/media.rb", "lib/dvdprofiler2xbmc/models/media_files.rb", "lib/dvdprofiler2xbmc/models/tmdb_movie.rb", "lib/dvdprofiler2xbmc/models/tmdb_profile.rb", "lib/dvdprofiler2xbmc/models/xbmc_info.rb", "lib/dvdprofiler2xbmc/open_cache_extension.rb", "lib/dvdprofiler2xbmc/views/cli.rb", "spec/cache_extensions.rb", "spec/dvdprofiler2xbmc_spec.rb", "spec/dvdprofiler_profile_spec.rb", "spec/imdb_profile_spec.rb", "spec/nfo_controller_spec.rb", "spec/samples/Collection.xml", "spec/samples/Collection.yaml", "spec/samples/Die Hard - 1988.nfo", "spec/samples/The Egg and I.dummy", "spec/spec.opts", "spec/spec_helper.rb", "spec/tmdb_movie_spec.rb", "spec/tmdb_profile_spec.rb", "spec/xbmc_info_spec.rb", "tasks/rspec.rake", "test/test_dvdprofiler2xbmc.rb", "test/test_dvdprofiler2xbmc_cli.rb", "test/test_helper.rb"]
   s.has_rdoc = true
   s.homepage = %q{http://www.github.com/royw/dvdprofiler2xbmc}
   s.post_install_message = %q{PostInstall.txt}
@@ -30,7 +30,7 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<activesupport>, [">= 2.0.2"])
       s.add_runtime_dependency(%q<xml-simple>, [">= 1.0.12"])
-      s.add_runtime_dependency(%q<royw-imdb>, [">= 0.0.8"])
+      s.add_runtime_dependency(%q<royw-imdb>, [">= 0.0.16"])
       s.add_runtime_dependency(%q<log4r>, [">= 1.0.5"])
       s.add_runtime_dependency(%q<commandline>, [">= 0.7.10"])
       s.add_runtime_dependency(%q<mash>, [">= 0.0.3"])
@@ -39,7 +39,7 @@ Gem::Specification.new do |s|
     else
       s.add_dependency(%q<activesupport>, [">= 2.0.2"])
       s.add_dependency(%q<xml-simple>, [">= 1.0.12"])
-      s.add_dependency(%q<royw-imdb>, [">= 0.0.8"])
+      s.add_dependency(%q<royw-imdb>, [">= 0.0.16"])
       s.add_dependency(%q<log4r>, [">= 1.0.5"])
       s.add_dependency(%q<commandline>, [">= 0.7.10"])
       s.add_dependency(%q<mash>, [">= 0.0.3"])
@@ -49,7 +49,7 @@ Gem::Specification.new do |s|
   else
     s.add_dependency(%q<activesupport>, [">= 2.0.2"])
     s.add_dependency(%q<xml-simple>, [">= 1.0.12"])
-    s.add_dependency(%q<royw-imdb>, [">= 0.0.8"])
+    s.add_dependency(%q<royw-imdb>, [">= 0.0.16"])
     s.add_dependency(%q<log4r>, [">= 1.0.5"])
     s.add_dependency(%q<commandline>, [">= 0.7.10"])
     s.add_dependency(%q<mash>, [">= 0.0.3"])

data/lib/dvdprofiler2xbmc.rb

@@ -8,16 +8,24 @@ require 'ftools'
 require 'imdb'
 require 'mash'
 require 'log4r'
+require 'ruby-debug'
 
-require 'dvdprofiler2xbmc/app'
 require 'dvdprofiler2xbmc/app_config'
-require 'dvdprofiler2xbmc/collection'
 require 'dvdprofiler2xbmc/extensions'
-require 'dvdprofiler2xbmc/media'
-require 'dvdprofiler2xbmc/media_files'
-require 'dvdprofiler2xbmc/nfo'
-require 'dvdprofiler2xbmc/imdb'
+require 'dvdprofiler2xbmc/controllers/app'
+require 'dvdprofiler2xbmc/controllers/fanart_controller'
+require 'dvdprofiler2xbmc/controllers/nfo_controller'
+require 'dvdprofiler2xbmc/controllers/thumbnail_controller'
+require 'dvdprofiler2xbmc/models/collection'
+require 'dvdprofiler2xbmc/models/dvdprofiler_profile'
+require 'dvdprofiler2xbmc/models/imdb_profile'
+require 'dvdprofiler2xbmc/models/media'
+require 'dvdprofiler2xbmc/models/media_files'
+require 'dvdprofiler2xbmc/models/tmdb_movie'
+require 'dvdprofiler2xbmc/models/tmdb_profile'
+require 'dvdprofiler2xbmc/models/xbmc_info'
+
 
 module Dvdprofiler2xbmc
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
 end

data/lib/dvdprofiler2xbmc/app_config.rb

@@ -82,11 +82,20 @@ module AppConfig
     @config.image_extensions    = [ 'jpg', 'jpeg', 'png', 'gif' ]
     @config.nfo_extensions      = [ 'nfo' ]
     # Destination file extensions
-    @config.thumbnail_extension  = 'tbn'
-    @config.nfo_extension        = 'nfo'
-    @config.nfo_backup_extension = 'nfo~'
-    @config.no_imdb_extension    = 'no_imdb_lookup'
-    @config.no_isbn_extension    = 'no_isbn'
+    @config.thumbnail_extension        = 'tbn'
+    @config.nfo_extension              = 'nfo'
+    @config.no_imdb_extension          = 'no_imdb_lookup'
+    @config.no_tmdb_extension          = 'no_tmdb_lookup'
+    @config.no_isbn_extension          = 'no_isbn'
+    @config.dvdprofiler_xml_extension  = 'dvdprofiler.xml'
+    @config.dvdprofiler_yaml_extension = 'dvdprofiler.yaml'
+    @config.imdb_xml_extension         = 'imdb.xml'
+    @config.imdb_yaml_extension        = 'imdb.yaml'
+    @config.tmdb_xml_extension         = 'tmdb.xml'
+    @config.tmdb_yaml_extension        = 'tmdb.yaml'
+    @config.fanart_extension           = '-fanart'
+    @config.new_extension              = '.new'
+    @config.backup_extension           = '~'
 
     # map some genre names
     @config.genre_maps = {
@@ -100,6 +109,7 @@ module AppConfig
     @config.file_permissions = 0664
     @config.dir_permissions = 0777
     @config.imdb_query = true
+    @config.tmdb_query = true
     @config.do_update = true
   end
 end

data/lib/dvdprofiler2xbmc/{app.rb → controllers/app.rb}

@@ -29,16 +29,16 @@ class DvdProfiler2Xbmc
 
   # the application's main execution loop
   def execute
-    AppConfig[:logger].info { "Processing directories: #{AppConfig[:directories].join(", ")}" }
-    collection_filepath = File.expand_path(AppConfig[:collection_filespec])
-    collection = Collection.new(collection_filepath)
+    AppConfig[:logger].info { "Media Directories:\n  #{AppConfig[:directories].join("\n  ")}" }
 
-    @media_files = MediaFiles.new(AppConfig[:directories], collection)
+    @media_files = MediaFiles.new(AppConfig[:directories])
     @media_files.titles.each do |title, medias|
       break if DvdProfiler2Xbmc.interrupted?
       medias.each do |media|
-        media.load
-        media.update if AppConfig[:do_update]
+        # note, NfoController update must be first as it sets isbn and imdb_id for media
+        NfoController.update(media)
+        ThumbnailController.update(media)
+        FanartController.update(media)
       end
     end
 

data/lib/dvdprofiler2xbmc/controllers/fanart_controller.rb

@@ -0,0 +1,73 @@
+# == Synopsis
+# Media encapsulates information about a single media file
+#
+# Usage:
+#  controller = FanartController.new(media)
+#  controller.update
+# or
+#  FanartController.update(media)
+class FanartController
+  attr_reader :media_path, :image_files, :year, :media_subdirs, :title, :title_with_year
+
+  def self.update(media)
+    FanartController.new(media).update
+  end
+
+  def initialize(media)
+    @media = media
+  end
+
+  # update the meta-data and thumbnails
+  def update
+    result = true
+    unless @media.imdb_id.blank?
+      if @media.fanart_files.empty?
+        fetch_fanart(@media.imdb_id)
+      end
+    end
+    result
+  end
+
+  protected
+
+  DISC_NUMBER_REGEX = /\.(cd|part|disk|disc)\d+/i
+
+  # TODO this only fetches the first fanart.  Probably should fetch
+  # all fanart but will need a naming scheme.  Need to research what
+  # the other xbmc utilities are doing.
+  def fetch_fanart(imdb_id)
+    profile = TmdbProfile.new(imdb_id, @media.path_to(:tmdb_xml_extension))
+    unless profile.nil? || profile.movie.blank?
+      movie = profile.movie
+      unless movie['fanarts'].blank?
+        fanart = movie['fanarts'].first
+        AppConfig[:logger].debug { "#{fanart.inspect}" }
+        src_url = fanart['content']
+        unless src_url.blank?
+          fanart_filename = File.basename(@media.media_path, ".*").gsub(DISC_NUMBER_REGEX, '')
+          fanart_filename += AppConfig[:fanart_extension]
+          fanart_filename += File.extname(src_url)
+          dest_filespec = File.join(File.dirname(@media.media_path), fanart_filename)
+          unless File.exist?(dest_filespec)
+            AppConfig[:logger].info { "src_url => #{src_url}" }
+            AppConfig[:logger].info { "dest_fanart_filespec => #{dest_filespec}" }
+            copy_fanart(src_url, dest_filespec)
+          end
+        end
+      end
+    end
+  end
+
+  # download the fanart
+  def copy_fanart(src_url, dest_filespec)
+    begin
+      data = open(src_url).read
+      File.open(dest_filespec, 'w') do |file|
+        file.print(data)
+      end
+    rescue Exception => e
+      AppConfig[:logger].error { "Error fetching fanart.\n  src_url => #{src_url},\n  dest_filespec => #{dest_filespec}\n  #{e.to_s}" }
+    end
+  end
+
+end