royw-dvdprofiler_collection 0.0.2

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,33 @@
+= dvdprofiler_collection
+
+dvdprofiler_collection is a companion to royw-imdb and royw-tmdb gems.
+
+This is an interface for the exported Collection.xml from DVD Profiler 3.5.1.
+
+Because the file size and parsing time of the Collection.xml can grow quite
+large, we extract only part of the meta-data then save into a Collection.yaml
+file which parses much faster.  On my 3GHz quad core (alas with ruby only using
+a single core), xml parsing is about 1:50 for about 1000 titles.
+
+The Collection model supports fuzzy matching of titles.
+
+The DvdprofilerProfile model provides a clean interface to the profiles using
+first() and all() class methods.  Searches can be by ISBN or title.
+Optionally a year may be provided to refine the search.
+
+The actual meta-data is accessed via the dvd_hash attribute.
+
+Examples:
+
+profile = DvdprofilerProfile.first(:isbn => '786936735390')
+profile = DvdprofilerProfile.first(:title => 'Sabrina', :year => '1995')
+profiles = DvdprofilerProfile.all(:title => 'Sabrina')
+
+puts profile.isbn
+puts profile.title
+
+profile.dvd_hash.each {|k,v| puts "#{k} => #{v}"}
+
+== Copyright
+
+Copyright (c) 2009 Roy Wright. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "dvdprofiler_collection"
+    gem.summary = %Q{TODO}
+    gem.email = "roy@wright.org"
+    gem.homepage = "http://github.com/royw/dvdprofiler_collection"
+    gem.authors = ["Roy Wright"]
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+
+    gem.files.reject! do |fn|
+      result = false
+      basename = File.basename(fn)
+      result = true if basename =~ /^tt\d+\.html/
+      result = true if basename =~ /^Collection.yaml/
+      result
+    end
+  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 = "dvdprofiler_collection #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION.yml

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

data/lib/dvdprofiler_collection.rb

@@ -0,0 +1,20 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'rubygems'
+require 'yaml'
+require 'xmlsimple'
+require 'ftools'
+require 'mash'
+# require 'log4r'
+require 'ruby-debug'
+
+require 'module_extensions'
+require 'numeric_extensions'
+require 'kernel_extensions'
+require 'file_extensions'
+require 'object_extensions'
+require 'string_extensions'
+require 'dvdprofiler_collection/optional_logger'
+require 'dvdprofiler_collection/collection'
+require 'dvdprofiler_collection/dvdprofiler_profile'

data/lib/dvdprofiler_collection/collection.rb

@@ -0,0 +1,187 @@
+# == Synopsis
+# This model encapsulates the DVDProfiler Collection.xml
+class Collection
+  # various regexes used to clean up a title for matching purposes.
+  # used in TITLE_REPLACEMENTS hash below
+  PUNCTUATION = /[\?\:\!\"\'\,\.\-\/\*]/
+  HTML_ESCAPES = /\&[a-zA-Z]+\;/
+  SQUARE_BRACKET_ENCLOSURES = /\[.*?\]/
+  PARENTHESIS_ENCLOSURES = /\(.*?\)/
+  MULTIPLE_WHITESPACES= /\s+/
+  STANDALONE_AMPERSAND = /\s\&\s/
+  WIDESCREEN = /widescreen/i
+  SPECIAL_EDITION = /special edition/i
+
+  # array of hashes is intentional as the order is critical
+  # the enclosures [...] & (...) must be removed first,
+  # then " & " must be replaced by " and ",
+  # then html escapes &...; must be replaced by a space,
+  # then remaining punctuation is replacesed by a space,
+  # finally multiple whitespaces are reduced to single whitespace
+  TITLE_REPLACEMENTS = [
+    { SQUARE_BRACKET_ENCLOSURES => ''      },
+    { PARENTHESIS_ENCLOSURES    => ''      },
+    { STANDALONE_AMPERSAND      => ' and ' },
+    { HTML_ESCAPES              => ' '     },
+    { WIDESCREEN                => ' '     },
+    { SPECIAL_EDITION           => ' '     },
+    { PUNCTUATION               => ' '     },
+    { MULTIPLE_WHITESPACES      => ' '     },
+  ]
+
+  attr_reader :isbn_dvd_hash, :title_isbn_hash, :isbn_title_hash
+
+  @filespec = nil
+
+  def initialize(filename, logger)
+    @title_isbn_hash = Hash.new
+    @isbn_dvd_hash = Hash.new
+    @isbn_title_hash = Hash.new
+    @filespec = filename
+    @logger = OptionalLogger.new(logger)
+    reload
+    save
+  end
+
+  # save as a collection.yaml file unless the existing
+  # collection.yaml is newer than the collection.xml
+  def save
+    unless @filespec.nil?
+      yaml_filespec = @filespec.ext('.yaml')
+      if !File.exist?(yaml_filespec) || (File.mtime(@filespec) > File.mtime(yaml_filespec))
+        @logger.info { "saving: #{yaml_filespec}" }
+        File.open(yaml_filespec, "w") do |f|
+          YAML.dump(
+            {
+              :title_isbn_hash => @title_isbn_hash,
+              :isbn_title_hash => @isbn_title_hash,
+              :isbn_dvd_hash => @isbn_dvd_hash,
+            }, f)
+        end
+      else
+        @logger.info { "not saving, yaml file is newer than xml file" }
+      end
+    else
+      @logger.error { "can not save, the filespec is nil" }
+    end
+  end
+
+  # load the collection from the collection.yaml if it exists,
+  # otherwise from the collection.xml
+  def reload
+    @title_isbn_hash.clear
+    @isbn_dvd_hash.clear
+    @isbn_title_hash.clear
+    collection = Hash.new
+    yaml_filespec = @filespec.ext('.yaml')
+    if File.exist?(yaml_filespec) && (File.mtime(yaml_filespec) > File.mtime(@filespec))
+      @logger.info { "Loading #{yaml_filespec}" }
+      data = YAML.load_file(yaml_filespec)
+      @title_isbn_hash = data[:title_isbn_hash]
+      @isbn_dvd_hash = data[:isbn_dvd_hash]
+      @isbn_title_hash = data[:isbn_title_hash]
+    else
+      elapsed_time = timer do
+        @logger.info { "Loading #{@filespec}" }
+        collection = XmlSimple.xml_in(@filespec, { 'KeyToSymbol' => true})
+      end
+      @logger.info { "XmlSimple.xml_in elapse time: #{elapsed_time.elapsed_time_s}" }
+      collection[:dvd].each do |dvd|
+        isbn = dvd[:id][0]
+        original_title = dvd[:title][0]
+        title = Collection.title_pattern(dvd[:title][0])
+        unless isbn.blank? || title.blank?
+          @title_isbn_hash[title] ||= []
+          @title_isbn_hash[title] << isbn
+          @isbn_title_hash[isbn] = original_title
+          dvd_hash = Hash.new
+          dvd_hash[:isbn] = isbn
+          dvd_hash[:title] = original_title
+          unless dvd[:actors].blank?
+            dvd_hash[:actors] = dvd[:actors].compact.collect {|a| a[:actor]}.flatten.compact.collect do |a|
+              name = []
+              name << a['FirstName'] unless a['FirstName'].blank?
+              name << a['MiddleName'] unless a['MiddleName'].blank?
+              name << a['LastName'] unless a['LastName'].blank?
+              info = Hash.new
+              info['name'] = name.join(' ')
+              info['role'] = a['Role']
+              info
+            end
+          end
+          dvd_hash[:genres] = dvd[:genres].collect{|a| a[:genre]}.flatten unless dvd[:genres].blank?
+          dvd_hash[:studios] = dvd[:studios].collect{|a| a[:studio]}.flatten unless dvd[:studios].blank?
+          dvd_hash[:productionyear] = [dvd[:productionyear].join(',')] unless dvd[:productionyear].blank?
+          dvd_hash[:rating] = [dvd[:rating].join(',')] unless dvd[:rating].blank?
+          dvd_hash[:runningtime] = [dvd[:runningtime].join(',')] unless dvd[:runningtime].blank?
+          dvd_hash[:released] = [dvd[:released].join(',')] unless dvd[:released].blank?
+          dvd_hash[:overview] = [dvd[:overview].join(',')] unless dvd[:overview].blank?
+          dvd_hash[:lastedited] = dvd[:lastedited][0] unless dvd[:lastedited].blank?
+          directors = find_directors(dvd[:credits])
+          dvd_hash[:directors] = directors unless directors.blank?
+          dvd_hash[:boxset] = dvd[:boxset] unless dvd[:boxset].blank?
+          dvd_hash[:mediatypes] = dvd[:mediatypes] unless dvd[:mediatypes].blank?
+          dvd_hash[:format] = dvd[:format] unless dvd[:format].blank?
+          @isbn_dvd_hash[isbn] = dvd_hash
+        end
+      end
+    end
+  end
+
+  def find_directors(dvd_credits)
+    directors = nil
+    begin
+      dvd[:credits].each do |credits_hash|
+        credits_hash[:credit].each do |credit_hash|
+          if((credit_hash['CreditType'] == 'Direction') || (credit_hash['CreditSubtype'] == 'Director'))
+            name = []
+            name << credit_hash['FirstName']  unless credit_hash['FirstName'].blank?
+            name << credit_hash['MiddleName'] unless credit_hash['MiddleName'].blank?
+            name << credit_hash['LastName']   unless credit_hash['LastName'].blank?
+            directors ||= []
+            directors << name.join(' ')
+          end
+        end
+      end
+    rescue
+    end
+    directors
+  end
+
+  # == Synopsis
+  # The titles found between LMCE's Amazon lookup and DVDProfiler sometimes differ in
+  # whether or not a prefix of "The", "A", or "An" is included in the title.  Here we
+  # create an Array of possible titles with and without these prefix words.
+  def Collection.title_permutations(base_title)
+    titles = []
+    unless base_title.nil? || base_title.empty?
+      titles << base_title
+      ['the', 'a', 'an'].each do |prefix|
+        titles << "#{prefix} " + base_title unless base_title =~ /^#{prefix}\s/
+        titles << $1 if base_title =~ /^#{prefix}\s(.*)$/
+      end
+    end
+    titles
+  end
+
+  # == Synopsis
+  # the titles found between LMCE's Amazon lookup and DVDProfiler quite often differ in the
+  # inclusion of punctuation and capitalization.  So we create a pattern of lower case words
+  # without punctuation and with single spaces between words.
+  def Collection.title_pattern(src_title)
+    title = nil
+    unless src_title.nil?
+      title = src_title.dup
+      title.downcase!
+      TITLE_REPLACEMENTS.each do |replacement|
+        replacement.each do |regex, value|
+          title.gsub!(regex, value)
+        end
+      end
+      title.strip!
+    end
+    title
+  end
+
+end
+

data/lib/dvdprofiler_collection/dvdprofiler_profile.rb

@@ -0,0 +1,138 @@
+# This is the model for the DVD Profiler profile which is used
+# to find meta data from DVD Profiler's exported Collection.xml
+#
+# Usage:
+#
+# profiles = DvdprofilerProfile.all(:titles => ['The Alamo'])
+#
+# profile = DvdprofilerProfile.first(:isbn => '012345678901')
+# or
+# profile = DvdprofilerProfile.first(:title => 'movie title')
+#
+# puts profile.dvd_hash[:key]
+# puts profile.to_xml
+# puts profile.isbn
+# puts profile.title
+# profile.save(media.path_to(:dvdprofiler_xml))
+#
+class DvdprofilerProfile
+
+  # options:
+  #  :isbn => String
+  #  :title => String
+  #  :logger => nil or logger instance
+  # returns:  Array of DvdprofilerProfile instances
+  def self.all(options={})
+    # :isbn_dvd_hash, :title_isbn_hash, :isbn_title_hash
+    result = []
+
+    # try finding by isbn first
+    if options.has_key?(:isbn) && !options[:isbn].blank?
+      dvd_hash = collection.isbn_dvd_hash[options[:isbn]]
+      unless dvd_hash.blank?
+        result << DvdprofilerProfile.new(dvd_hash, options[:isbn], options[:title], options[:logger])
+      end
+    end
+
+    # if unable to find by isbn, then try finding by title
+    if result.empty? && options.has_key?(:title)
+      isbns = self.find_isbns(options)
+      unless isbns.blank?
+        isbns.each do |isbn|
+          dvd_hash = collection.isbn_dvd_hash[isbn]
+          unless dvd_hash.blank?
+            unless options[:year].blank?
+              if dvd_hash[:productionyear].include? options[:year]
+                result << DvdprofilerProfile.new(dvd_hash, isbn, options[:title], options[:logger])
+              end
+            else
+              result << DvdprofilerProfile.new(dvd_hash, isbn, options[:title], options[:logger])
+            end
+          end
+        end
+      end
+    end
+
+    # return all profiles if neither :isbn nor :title are given
+    if result.empty? && !options.has_key?(:isbn) && !options.has_key?(:title)
+      collection.isbn_dvd_hash.each do |isbn, dvd_hash|
+        result << DvdprofilerProfile.new(dvd_hash, isbn, nil, options[:logger])
+      end
+    end
+
+    result
+  end
+
+  # options:
+  #  :isbn => String
+  #  :title => String
+  # returns:  DvdprofilerProfile instance or nil
+  def self.first(options={})
+    all(options).first
+  end
+
+  # look up ISBN by title
+  # expects a :title option
+  # returns Array of ISBN Strings
+  def self.find_isbns(options={})
+    result = []
+    if options.has_key?(:title)
+      result = [collection.title_isbn_hash[Collection.title_pattern(options[:title])]].flatten.uniq.compact
+    end
+    result
+  end
+
+  class << self
+    @collection_filespec = 'Collection.xml'
+    attr_accessor :collection_filespec
+  end
+
+  protected
+
+  def self.collection(logger=nil)
+    @collection ||= Collection.new(File.expand_path(@collection_filespec), logger)
+  end
+
+  def initialize(dvd_hash, isbn, title, logger)
+    @dvd_hash = dvd_hash
+    @isbn = isbn
+    @title = title
+    @title ||= @dvd_hash[:title]
+    @logger = OptionalLogger.new(logger)
+  end
+
+  public
+
+  attr_reader :isbn, :title, :dvd_hash
+
+  def to_xml
+    data = @dvd_hash.stringify_keys
+    data.delete_if { |key, value| value.nil? }
+    xml = XmlSimple.xml_out(data, 'NoAttr' => true, 'RootName' => 'movie')
+  end
+
+  def save(filespec)
+    begin
+      xml = self.to_xml
+      unless xml.blank?
+        @logger.debug { "saving #{filespec}" }
+        DvdProfiler2Xbmc.save_to_file(filespec, xml)
+      end
+    rescue Exception => e
+      @logger.error { "Unable to save dvdprofiler 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