movie_organizer 0.1.11 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e79b66679e3034ba041b6a74648f9588579e177bb6aeeba31f6ea4dc55648ec
-  data.tar.gz: e01ff240650b55d4237431b30fb1988ffb640a129fa5261448ab0dd4fee6add7
+  metadata.gz: 5157291fa0d5ccda33cc68f1af1f09a0a58fd42474b8e676fe838c2c1bc77964
+  data.tar.gz: 18a25b3e745211e672de63c45d5fce5596f32078c2efe35f7f59fd91417e5c26
 SHA512:
-  metadata.gz: f52967cf08b3d97695c63960cea76713ac99d55154ffe8c9674153a9a5907ed1057e676fce98169ff76c4a84353ee1185bfb8a3d3f28779d0342135aa087cb10
-  data.tar.gz: 245370271ea233c8c3f43da77860534b5b6527dcd835238454fddcfcf45233f6cf9345b2e078b2b4603aeb421dc2fc7bb21bf89e14fd64cf33d4ddfb586700a6
+  metadata.gz: 4cc23bf91f29c382261e349a7cb8d2e765a933f3ab0afe038d5263fe2fa749bd9af6c6c8f4b8102e03a11036a5a4783771a96337b35dda5a4076a6d0418c72d4
+  data.tar.gz: fccf79f2d5390c38f98cf10865688aa9365a81d26d09f5edfdb72a036d8ab903a3a1e44db74cf6ca609262955435272a5844fb94876be242edde56b44bde27e3

data/.gitignore

@@ -18,3 +18,4 @@ mkmf.log
 /spec/.DS_Store
 /.DS_Store
 .DS_Store
+/spec/fixtures/vcr_cassettes

data/.rubocop.yml

@@ -73,3 +73,6 @@ Metrics/MethodLength:
 
 Metrics/ClassLength:
   Max: 120
+
+Metrics/AbcSize:
+  Max: 20

data/CHANGELOG

@@ -1,3 +1,13 @@
+*1.0.1* (April 17, 2018)
+
+* Temporarily cache the lookup instances for 3rd party service - for reuse during runs
+* Refine SSH/SCP remote moving/copying
+* Encapsulate media determination in each type
+* Remove some unused dependencies
+* Refactor all but TV Show specs
+* Add Options singleton
+* Fix some logging issues
+
 *0.1.11* (March 27, 2018)
 
 * Fix bug where it wouldn't always autoload net-scp.

data/Gemfile

@@ -3,7 +3,8 @@
 source 'https://rubygems.org'
 git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
-# gem 'themoviedb', github: 'midwire/themoviedb'
+# gem 'tvdbr', github: 'midwire/tvdbr'
+gem 'tvdbr', path: '../tvdbr'
 
 # Specify your gem's dependencies in movie_organizer.gemspec
 gemspec

data/README.md

@@ -1,10 +1,10 @@
 # MovieOrganizer
 
-Automatically organize movies, tv shows and home videos.
+Automatically organize movies, tv shows ~~and home videos~~. **NOTE: home videos are temporarily disabled for now**
 
 I use [Plex](https://www.plex.tv/) as the centerpiece of my home entertainment center, which requires that I rip my BluRay movies and TV shows, and copy them into a certain location so my [Plex server](https://www.plex.tv/downloads/) can recognize them.
 
-MovieOrganizer makes the job of organizing my ripped movies, tv shows and home videos as simple as:
+MovieOrganizer makes the job of organizing my ripped movies, tv shows ~~and home videos~~ as simple as:
 
 ```bash
 movie_organizer
@@ -20,12 +20,13 @@ Processing [/Users/midwire/Downloads/The Matrix (1990).mp4] - MovieOrganizer::Mo
 ## Features
 
 * Copies media to remote hosts
-* Can differentiate between most Movies, TV Shows and Home Video if they are named properly, and copy each to the appropriately configured directory
+* Can differentiate between most Movies, TV Shows ~~and Home Video~~ if they are named properly, and copy each to the appropriately configured directory. See [Plex Media Preparation](https://support.plex.tv/articles/categories/media-preparation/)
 * Uses [The Movie Database](https://www.themoviedb.org) for movie identification
+* Uses [The TV DB](https://www.thetvdb.com/) for TV show identification
 
 ## Caveats
 
-Note that this is beta software. I wrote it as a hack because I got tired of constantly copying my media over to Plex by hand.  Having said that, it works but there are edge cases that are probably not covered. If you find a bug or problem, please file an issue and I'll address it ASAP.
+Note that this is beta software. I wrote it as a hack because I got tired of constantly copying my media over to Plex by hand.  It does a decent job of recognizing and grooming media filenames but it is not perfect. There are edge cases that are not covered for really wonky filenames.  If you find a bug or problem, please file an issue and I'll address it ASAP.
 
 ## Installation
 
@@ -34,24 +35,27 @@ Note that this is beta software. I wrote it as a hack because I got tired of con
 ## Configuration
 
 Sign up for an account at [The Movie Database](https://www.themoviedb.org/) and get an API key.
+Sign up for an account at [The TV DB](https://www.thetvdb.com/) and get an API key.
 
 Create a file in your home directory named `.movie_organizer.yml` as follows:
 
 ```yaml
 ---
-:space_warning: 20GB
 :new_media_directories:
-- "/Users/midwire/media_rips" # <- new media directory
+- "/Users/midwire/media_rips" # <- new media (source) directory
 :tv_shows:
   :directory: "/Volumes/Genesis/TV Series" # <- a local directory
 :movies:
   :tmdb_key: df08efec9f01985d401a3cfedf5628a2 # <- use your own API key (this one is fake)
   :directory: ssh://plex_admin@plex.local/media/media1/movies # <- remote directory
 :videos:
+  :tvdb_key: df08efec9f01985d401a3cfedf5628a2 # <- use your own API key (this one is fake)
   :directory: "ssh://plex_admin@plex.local/media/media1/Family Videos" # <- remote directory
 ```
 
-**NOTE:** If you want to use a remote host, you will need to configure passwordless logins using your ssh-key, which is outside the scope of this document.  If you don't know how, please do a search for
+**NOTE:** If your Plex media is on a remote host, you will need to configure passwordless logins using your ssh-key, which is outside the scope of this document.  If you don't know how, please do a search for `ssh public key authentication`.
+
+You can also set your api keys, `TMDB_KEY` and `TVDB_KEY` as environment variables, in which case they will be used instead of the corresponding settings in your `.movie_organizer.yml` file. In other words, the environment variables override the .yml file.  Useful for testing.
 
 Remote hosts are specified in this format:
 
@@ -61,21 +65,30 @@ ssh://username@hostname/path/to/remote/destination
 
 ## Usage
 
-You should be able to simply run `movie_organizer`
+If you have the yaml configuration settings configured correctly, you should be able to simply run `movie_organizer`. However, it tries to prompt for most missing settings.
 
 Here are the command line options:
 
 ```bash
 Options:
-  -s, --source-dir=<s>           Source directories containing media files. Colon (:) separated. (Default: /Users/midwire/media_rips)
-  -d, --dry-run                  Do not actually move or copy files
-  -p, --preserve-episode-name    Preserve episode names if they exist (experimental)
-  -v, --verbose                  Be verbose with output
-  -h, --help                     Show this message
+  -s, --source-dir=<s>    Source directories containing media files. Colon (:) separated.
+  -c, --copy              Copy instead of Move files
+  -d, --dry-run           Do not actually move or copy files
+  -v, --verbose           Be verbose with output
+  -h, --help              Show this message
 ```
 
+## TODO
+
+* Consolidate and better manage regular expressions
+* Handle multi-part movies and videos `Beetlejuice (1996)-part1.mp4`, `Beetlejuice (1996)-part2.mp4`, etc.
+
 ## Attribution
 
 ### The Movie Database
 
-<img src="tmdb-logo-primary-green.png" alt="TMDB Logo" style="float:left; padding: 0 10px 0 0;"/> We are profoundly pleased to have access to [The Movie Database](https://www.themoviedb.org) API. This product uses the TMDb API but is not endorsed or certified by TMDb.
+<img src="tmdb-logo-primary-green.png" alt="TMDB Logo" style="float:left; padding: 0 10px 0 0;"/> We are pleased to have access to [The Movie Database](https://www.themoviedb.org) API. This product uses the TMDb API but is not endorsed or certified by TMDb.
+
+### The TV DB
+
+We are also pleased to have access to [The TV DB](https://www.tvdb.com) API. Please help by contributing TV Show information and artwork.

data/lib/movie_organizer.rb

@@ -27,7 +27,23 @@ module MovieOrganizer
     #:nocov:
   end
 
-  def self.source_directories(settings = Settings.new, test_response = nil)
+  def self.options
+    MovieOrganizer::Options.instance
+  end
+
+  def self.verbose_puts(string)
+    Logger.instance.info(" #{string}") if options[:verbose]
+  end
+
+  def self.os
+    if RUBY_PLATFORM.match?(/cygwin|mswin|mingw|bccwin|wince|emx/)
+      :retarded
+    else
+      :normal
+    end
+  end
+
+  def self.source_directories(settings = Settings.instance, test_response = nil)
     settings[:new_media_directories] || begin
       strings = prompt_for('Media source directories (separated by a colon)', test_response)
       settings[:new_media_directories] = strings.split(':')
@@ -36,7 +52,7 @@ module MovieOrganizer
     end
   end
 
-  def self.tmdb_key(settings = Settings.new, test_response = nil)
+  def self.tmdb_key(settings = Settings.instance, test_response = nil)
     return settings[:movies][:tmdb_key] if settings[:movies] && settings[:movies][:tmdb_key]
     settings[:movies] ||= {}
     settings[:movies][:tmdb_key] =
@@ -45,7 +61,7 @@ module MovieOrganizer
     settings[:movies][:tmdb_key]
   end
 
-  def self.movie_directory(settings = Settings.new, test_response = nil)
+  def self.movie_directory(settings = Settings.instance, test_response = nil)
     return settings[:movies][:directory] if settings[:movies] && settings[:movies][:directory]
     settings[:movies] ||= {}
     settings[:movies][:directory] =
@@ -54,7 +70,7 @@ module MovieOrganizer
     settings[:movies][:directory]
   end
 
-  def self.tv_shows_directory(settings = Settings.new, test_response = nil)
+  def self.tv_shows_directory(settings = Settings.instance, test_response = nil)
     return settings[:tv_shows][:directory] if settings[:tv_shows] && settings[:tv_shows][:directory]
     settings[:tv_shows] ||= {}
     settings[:tv_shows][:directory] =
@@ -63,7 +79,7 @@ module MovieOrganizer
     settings[:tv_shows][:directory]
   end
 
-  def self.video_directory(settings = Settings.new, test_response = nil)
+  def self.video_directory(settings = Settings.instance, test_response = nil)
     return settings[:videos][:directory] if settings[:videos] && settings[:videos][:directory]
     settings[:videos] ||= {}
     settings[:videos][:directory] =
@@ -80,13 +96,16 @@ module MovieOrganizer
   end
   #:nocov:
 
-  autoload :FileCopier, 'movie_organizer/file_copier'
-  autoload :Logger,     'movie_organizer/logger'
-  autoload :Media,      'movie_organizer/media'
-  autoload :MediaList,  'movie_organizer/media_list'
-  autoload :Movie,      'movie_organizer/movie'
-  autoload :Organizer,  'movie_organizer/organizer'
-  autoload :Settings,   'movie_organizer/settings'
-  autoload :TvShow,     'movie_organizer/tv_show'
-  autoload :Video,      'movie_organizer/video'
+  autoload :FileCopier,   'movie_organizer/file_copier'
+  autoload :Logger,       'movie_organizer/logger'
+  autoload :Medium,       'movie_organizer/medium'
+  autoload :MediaList,    'movie_organizer/media_list'
+  autoload :Movie,        'movie_organizer/movie'
+  autoload :Options,      'movie_organizer/options'
+  autoload :Organizer,    'movie_organizer/organizer'
+  autoload :Settings,     'movie_organizer/settings'
+  autoload :TmdbInstance, 'movie_organizer/tmdb_instance'
+  autoload :TvdbInstance, 'movie_organizer/tvdb_instance'
+  autoload :TvShow,       'movie_organizer/tv_show'
+  autoload :Video,        'movie_organizer/video'
 end

data/lib/movie_organizer/file_copier.rb

@@ -4,41 +4,46 @@ require 'net/scp'
 
 module MovieOrganizer
   class FileCopier
-    attr_accessor :filename, :target_file, :options
-    attr_reader :username, :hostname, :remote_filename, :logger
+    attr_accessor :filename, :target_file
+    attr_reader :username, :hostname, :remote_filename
 
-    def initialize(filename, target_file, options)
+    def initialize(filename, target_file)
       @filename = filename
       @target_file = target_file
-      @options = options
-      @logger = Logger.instance
+      @dry_run = MovieOrganizer.options[:dry_run]
+      @verbose = MovieOrganizer.options[:verbose]
     end
 
-    def copy
+    def copy!
       ssh? ? remote_copy : local_copy
     end
 
     private
 
     def local_copy
-      FileUtils.mkdir_p(File.dirname(target_file))
-      FileUtils.copy(
-        filename,
-        target_file,
-        noop: options[:dry_run]
-      )
+      dir = File.dirname(target_file)
+      FileUtils.mkdir_p(dir) unless File.exist?(dir)
+      if File.exist?(target_file)
+        Logger.instance.info("    already exists: [#{target_file.green.bold}]")
+        return true
+      end
+      if MovieOrganizer.options[:copy]
+        FileUtils.copy(filename, target_file, noop: @dry_run, verbose: @verbose)
+      else
+        FileUtils.move(filename, target_file, noop: @dry_run, verbose: @verbose)
+      end
     end
 
     def remote_copy
       parse_target
-      return do_dry_run if options[:dry_run]
+      return do_remote_dry_run if @dry_run
       create_remote_dir
       copy_file_to_remote
     end
 
-    def do_dry_run
-      puts("Would remotely execute: [#{"mkdir -p '#{target_dir}'"}] on #{hostname}")
-      puts("Would execute: [#{"scp '#{filename}' '#{remote_filename}'"}]")
+    def do_remote_dry_run
+      Logger.instance.info("Would remotely execute: [#{create_remote_dir_cmd}] on #{hostname}")
+      Logger.instance.info("Would execute: [#{copy_file_to_remote_cmd}]")
     end
 
     def target_dir
@@ -65,20 +70,29 @@ module MovieOrganizer
       target_file.match?(/^ssh:/)
     end
 
+    def create_remote_dir_cmd
+      "mkdir -p \"#{target_dir}\""
+    end
+
+    def copy_file_to_remote_cmd
+      "scp '#{filename}' '#{remote_filename}'"
+    end
+
     def create_remote_dir
       Net::SSH.start(hostname, username, timeout: 5) do |ssh|
-        ssh.exec("mkdir -p '#{target_dir}'")
+        ssh.exec!(create_remote_dir_cmd)
       end
     rescue Net::SSH::ConnectionTimeout, Errno::EHOSTUNREACH, Errno::EHOSTDOWN
-      logger.error("ConnectionTimeout: the host '#{hostname}' is unreachable.".red)
+      Logger.instance.error("ConnectionTimeout: the host '#{hostname}' is unreachable.".red)
     end
 
     def copy_file_to_remote
       Net::SCP.start(hostname, username) do |scp|
         scp.upload!(filename, remote_filename)
       end
+      FileUtils.rm(filename, noop: @dry_run) unless MovieOrganizer.options[:copy]
     rescue Net::SSH::ConnectionTimeout, Errno::EHOSTUNREACH, Errno::EHOSTDOWN
-      logger.error("ConnectionTimeout: the host '#{hostname}' is unreachable.".red)
+      Logger.instance.error("ConnectionTimeout: the host '#{hostname}' is unreachable.".red)
     end
   end
 end

data/lib/movie_organizer/logger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'singleton'
 require 'logger'
 

data/lib/movie_organizer/media_list.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'mime/types'
-
 module MovieOrganizer
   class MediaList
     attr_accessor :file_collection
@@ -11,21 +9,9 @@ module MovieOrganizer
       @file_collection = []
       directories.each do |directory|
         Dir["#{directory}/**/*"].each do |entry|
-          file_collection << entry if media?(entry)
+          file_collection << entry if Medium.media_file?(entry)
         end
       end
     end
-
-    def media?(filename)
-      video?(filename) || subtitle?(filename)
-    end
-
-    def video?(filename)
-      MIME::Types.of(filename).map(&:media_type).include?('video')
-    end
-
-    def subtitle?(filename)
-      !MIME::Types.of(filename).map(&:content_type).grep(/(subtitle$|subrip$)/).empty?
-    end
   end
 end

data/lib/movie_organizer/medium.rb

@@ -0,0 +1,176 @@
+# frozen_string_literal: true
+
+require 'filemagic'
+require 'themoviedb'
+
+module MovieOrganizer
+  # Medium is a class factory for it's derived classes
+  class Medium
+    attr_reader :filename, :target
+
+    MIME_TYPES = %w[
+      video/mp4
+      video/ogg
+      video/webm
+      video/mpeg
+      video/quicktime
+      video/x-matroska
+      video/x-msvideo
+    ].freeze
+    OCTET_STREAM_EXTENSIONS = %w[.3gp .mp4].freeze
+
+    class << self
+      # Determine if a file is a processable media file
+      #
+      # @return [Boolean] true if file is processable, false if not
+      def media_file?(filepath)
+        return false if File.directory?(filepath)
+
+        MovieOrganizer.verbose_puts("checking: #{filepath}")
+
+        mime = mime_type(filepath)
+
+        return true if
+          mime == 'application/octet-stream' &&
+          OCTET_STREAM_EXTENSIONS.include?(File.extname(filepath))
+
+        MIME_TYPES.include?(mime)
+      end
+
+      # Build the proper instance of a child class. This method does not check if the file is
+      # of the proper mime-type
+      #
+      # @param filepath [String] full path to the file
+      # @return [Object] instance of the corresponding class type
+      def build_instance(filepath)
+        return nil unless media_file?(filepath)
+
+        tvdb_instance = TvShow.match?(filepath)
+        return TvShow.new(filepath, tvdb_instance) if tvdb_instance
+
+        tmdb_instance = Movie.match?(filepath)
+        return Movie.new(filepath, tmdb_instance) if tmdb_instance
+
+        # return Video.new(filepath) if Video.match?(filepath)
+
+        nil
+      end
+
+      private
+
+      # rubocop:disable Metrics/AbcSize
+      # rubocop:disable Metrics/MethodLength
+      def sanitize(str)
+        cleanstr = str.dup
+        cleanstr.gsub!(/-\s*-/, '')
+        cleanstr.gsub!(/\[?1080p\]?/, '')
+        cleanstr.gsub!(/m?\[?720p\]?/, '')
+        cleanstr.gsub!(/\[[^\]]+\]/, '')
+        cleanstr.gsub!(/ECI/, '')
+        cleanstr.gsub!(/EXTENDED/, '')
+        cleanstr.gsub!(/UNRATED/, '')
+        cleanstr.gsub!(/ETRG/, '')
+        cleanstr.gsub!(/VPPV/, '')
+        cleanstr.gsub!(/HQ/, '')
+        cleanstr.gsub!(/x264/, '')
+        cleanstr.gsub!(/AAC/, '')
+        cleanstr.gsub!(/[\.\s]B[dr]Rip[\.\s]/i, '')
+        cleanstr.gsub!(/\.Br\./i, '')
+        cleanstr.gsub!(/BluRay/i, '')
+        cleanstr.gsub!(/HDTV/i, '')
+        cleanstr.gsub!(/WEBRip/i, '')
+        cleanstr.gsub!(/(Deceit)?\.?YIFY/, '')
+        cleanstr.gsub!(/-?xvid-?/i, '')
+        cleanstr.gsub!(/-?maxspeed/i, '')
+        cleanstr.gsub!(/www\.torentz\.3xforum\.ro\.avi/i, '')
+        cleanstr.gsub!(/-lol/i, '')
+        cleanstr.gsub!(/\+HI/i, '')
+        cleanstr.gsub!(/muxed/i, '')
+        cleanstr.gsub!(/\(dvd\)/i, '')
+        cleanstr.gsub!(/dvdscr/i, '')
+        cleanstr.gsub!(/mkv/i, '')
+        cleanstr.gsub!(/aqos/i, '')
+        cleanstr.gsub!(/ac3/i, '')
+        cleanstr.gsub!(/hive/i, '')
+        cleanstr.gsub!(/-?cm8/i, '')
+        cleanstr.gsub!(/[\d\.]+mb/i, '')
+        cleanstr.gsub!(/[\d\.]+gb/i, '')
+        cleanstr.gsub!(/\s\s+/, ' ')
+        cleanstr.tr!('_', ' ') # underscores
+        cleanstr.gsub!(/[\.\+]/, ' ')
+        cleanstr.strip!
+        cleanstr
+      end
+      # rubocop:enable Metrics/MethodLength
+      # rubocop:enable Metrics/AbcSize
+
+      def basename(filepath)
+        File.basename(filepath, extname(filepath))
+      end
+
+      def extname(filepath)
+        File.extname(filepath)
+      end
+
+      def dirname(filepath)
+        File.dirname(filepath)
+      end
+
+      def mime_type(filepath)
+        file_magic ||= FileMagic.mime
+        mime_str = file_magic.file(filepath.to_s)
+        mime_str.split(/;/).first
+      end
+    end
+
+    def initialize(filename)
+      @filename = filename
+    end
+
+    def basename
+      self.class.send(:basename, filename)
+    end
+
+    def extname
+      self.class.send(:extname, filename)
+    end
+
+    def dirname
+      self.class.send(:dirname, filename)
+    end
+
+    def sanitized_basename
+      self.class.send(:sanitize, basename)
+    end
+
+    def sanitize(str)
+      self.class.send(:sanitize, str)
+    end
+
+    # Determine the supposed year in the filename or directory to match against
+    # the release date for a potential movie
+    #
+    # @return [String] Year derived from the filename or directory
+    def derived_year
+      @derived_year ||= begin
+        md = basename.match(/\((\d\d\d\d)\)|(19\d\d)|(20\d\d)/)
+        # try dirname if filename has no year
+        md = dirname.match(/\((\d\d\d\d)\)|(19\d\d)|(20\d\d)/) if md.nil?
+        md ? md.captures.compact.first : nil
+      end
+    end
+
+    def year
+      release_date&.year
+    end
+
+    # Groom the filename to reflect a proper naming scheme.
+    # Copy file to the configured destination.
+    #
+    def groom
+      process!
+      fc = FileCopier.new(filename, target)
+      fc.copy!
+    end
+  end
+end