movie_organizer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 56db1180e21190c3099cc45f75066d9a27c9fb34d74364ed64c87c22f229da18
+  data.tar.gz: 34a39c981eb1cc29a7fdff7bb7bbd53ea464b9d0ebf973685bfe716e5da824af
+SHA512:
+  metadata.gz: 9fbd33cf4a225627e99925e09f5d4a0cb3e2f13cc24cc2ef7da4485547079f07996ab6531491d8c1025d7394b0766d501e58a2ab312fbf09919efcccd8fd2616
+  data.tar.gz: 3db9a4aecbf719ceb5185f2ad00f78c853bc13df6c0ce400d4c8f954baa75ae9a98a1a0eb5b8c74dfb45170a0fe0b4c6a944000824c60c634a25ecfb2fb91b55

data/.gitignore

@@ -0,0 +1,19 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.env*
+/stubs
+/vendor
+/spec/.DS_Store
+/.DS_Store

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format doc

data/.rubocop.yml

@@ -0,0 +1,75 @@
+AllCops:
+  TargetRubyVersion: 2.3
+
+  # Include gemspec and Rakefile
+  Include:
+    - '**/*.gemspec'
+    - '**/*.podspec'
+    - '**/*.jbuilder'
+    - '**/*.rake'
+    - '**/Gemfile'
+    - '**/Rakefile'
+    - '**/Capfile'
+    - '**/Guardfile'
+    - '**/Podfile'
+    - '**/Thorfile'
+    - '**/Vagrantfile'
+  Exclude:
+    - 'vendor/**/*'
+    - 'stubs/**/*'
+    - 'spec/support/shared_contexts/*'
+
+# Checks formatting of special comments
+CommentAnnotation:
+  Keywords:
+    - TODO
+    - FIXME
+    - OPTIMIZE
+    - HACK
+    - REVIEW
+
+########################################
+# Style Cops
+
+Style/Documentation:
+  Enabled: false
+
+Style/FileName:
+  Enabled: false
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+Style/RaiseArgs:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/PerlBackrefs:
+  Enabled: false
+
+########################################
+# Lint Cops
+
+Lint/Eval:
+  Enabled: false
+
+########################################
+# Metrics Cops
+
+Metrics/LineLength:
+  Max: 110
+
+Metrics/MethodLength:
+  CountComments: false # count full line comments?
+  Max: 20
+
+Metrics/ClassLength:
+  Max: 120

data/CHANGELOG

@@ -0,0 +1,3 @@
+*0.0.1* (March 08, 2015)
+
+* Initial Commit

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+gem 'themoviedb', github: 'midwire/themoviedb'
+
+# Specify your gem's dependencies in movie_organizer.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,37 @@
+# rubocop:disable all
+# clearing :on
+
+guard :bundler do
+  require 'guard/bundler'
+  require 'guard/bundler/verify'
+  helper = Guard::Bundler::Verify.new
+
+  files = ['Gemfile']
+  files += Dir['*.gemspec'] if files.any? { |f| helper.uses_gemspec?(f) }
+
+  # Assume files are symlinked from somewhere
+  files.each { |file| watch(helper.real_path(file)) }
+end
+
+CMD = 'bundle exec rspec -f doc --color'
+
+guard :rspec, cmd: CMD do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end
+
+# guard :rubocop, cli: ['-D'] do
+#   watch(%r{.+\.rb$})
+#   watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+# end
+# rubocop:enable all

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Chris Blackburn
+
+MIT License
+
+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.md

@@ -0,0 +1,81 @@
+# MovieOrganizer
+
+Automatically organize movies, tv shows and home videos.
+
+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:
+
+```bash
+movie_organizer
+
+Starting MovieOrganizer...
+Processing [/Users/midwire/Downloads/The Matrix (1990).mp4] - MovieOrganizer::Movie
+    target dir: [ssh://username@plex_server/media/movies/The Matrix (1990)]
+    target file: [ssh://username@plex_server/media/movies/The Matrix (1990)/The Matrix (1990).mp4]
+
+...
+```
+
+## 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
+* Uses [The Movie Database](https://www.themoviedb.org) for movie 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.
+
+## Installation
+
+    $ gem install movie_organizer
+
+## Configuration
+
+Sign up for an account at [The Movie Database](https://www.themoviedb.org/) 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
+: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:
+  :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
+
+Remote hosts are specified in this format:
+
+```bash
+ssh://username@hostname/path/to/remote/destination
+```
+
+## Usage
+
+You should be able to simply run `movie_organizer`
+
+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
+```
+
+## 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.

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec
+
+begin
+  require 'midwire_common/rake_tasks'
+rescue LoadError
+  puts ">>> Could not load 'midwire_common' gem."
+  exit
+end

data/bin/movie_organizer

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'bundler/setup'
+
+require 'movie_organizer'
+require 'movie_organizer/organizer'
+
+MovieOrganizer::Organizer.instance.start

data/lib/movie_organizer.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+# Create a .test.env and a .development.env for your different local
+# environments
+require 'dotenv'
+require 'colored'
+require 'readline'
+
+paths = %W(.env .env.#{ENV['APP_ENV']}).map { |name| "#{Dir.pwd}/#{name}" }
+Dotenv.load(*paths).each { |k, v| ENV[k] = v }
+
+require 'movie_organizer/version'
+require 'midwire_common/string'
+
+module MovieOrganizer
+  def self.root
+    Pathname.new(File.dirname(__FILE__)).parent
+  end
+
+  def self.current_environment
+    ENV.fetch('APP_ENV', 'development')
+  end
+
+  def self.config_file(filename = '.movie_organizer.yml')
+    return root.join('spec', 'fixtures', filename) if current_environment == 'test'
+    #:nocov:
+    home = ENV.fetch('HOME')
+    file = ENV.fetch('MO_CONFIG_FILE', File.join(home, '.movie_organizer.yml'))
+    FileUtils.touch(file)
+    file
+    #:nocov:
+  end
+
+  def self.source_directories(settings = Settings.new, test_response = nil)
+    settings[:new_media_directories] || begin
+      strings = prompt_for('Media source directories (separated by a colon)', test_response)
+      strings.split(':')
+    end
+  end
+
+  #:nocov:
+  def self.prompt_for(message = '', test_response = nil)
+    prompt = "#{message.dup}\n? "
+    return test_response if test_response
+    Readline.readline(prompt, true).squeeze(' ').strip
+  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'
+end

data/lib/movie_organizer/file_copier.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module MovieOrganizer
+  class FileCopier
+    attr_accessor :filename, :target_file, :options
+    attr_reader :username, :hostname, :remote_filename
+
+    def initialize(filename, target_file, options)
+      @filename = filename
+      @target_file = target_file
+      @options = options
+    end
+
+    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]
+      )
+    end
+
+    def remote_copy
+      parse_target
+      return do_dry_run if options[:dry_run]
+      Net::SSH.start(hostname, username) do |ssh|
+        ssh.exec("mkdir -p '#{target_dir}'")
+      end
+      Net::SCP.start(hostname, username) do |scp|
+        scp.upload!(filename, remote_filename)
+      end
+    end
+
+    def do_dry_run
+      puts("Would remotely execute: [#{"mkdir -p '#{target_dir}'"}] on #{hostname}")
+      puts("Would execute: [#{"scp '#{filename}' '#{remote_filename}'"}]")
+    end
+
+    def target_dir
+      @target_dir ||= begin
+        parts = @remote_filename.split('/')
+        parts[0..parts.length - 2].join('/').to_s
+      end
+    end
+
+    def parse_target
+      return nil if @parse_target
+      @parse_target = true
+      temp ||= target_file.to_s.split('/')[2..99]
+      md = temp.join('/').match(/([\w\-\.]+)@([^\/]+)(\/.+)$/)
+      @username = md[1]
+      @hostname = md[2]
+      @remote_filename = md[3]
+      if @username.nil? || @hostname.nil? || @remote_filename.nil?
+        fail 'SSH path not formatted properly. Use [ssh://username@hostname/absolute/path]'
+      end
+    end
+
+    def ssh?
+      target_file.match?(/^ssh:/)
+    end
+  end
+end

data/lib/movie_organizer/logger.rb

@@ -0,0 +1,47 @@
+require 'singleton'
+require 'logger'
+
+module MovieOrganizer
+  class Logger
+    include Singleton
+
+    attr_accessor :log_provider
+
+    def initialize(provider = default_logger)
+      @log_provider = provider
+    end
+
+    def log_exception(e, data = {})
+      msg = "EXCEPTION : #{e.class.name} : #{e.message}"
+      msg += "\n data : #{data.inspect}" if data && !data.empty?
+      msg += "\n  #{e.backtrace[0, 6].join("\n  ")}"
+      log_provider.error(msg)
+    end
+
+    def method_missing(meth, *args, &block)
+      if log_provider.respond_to?(meth)
+        log_provider.send(meth, *args, &block)
+      else
+        super
+      end
+    end
+
+    def respond_to?(meth, include_private = false)
+      if log_provider.respond_to?(meth)
+        true
+      else
+        super
+      end
+    end
+
+    private
+
+    def default_logger
+      logger = ::Logger.new(STDOUT)
+      logger.formatter = proc do |_, _, _, msg|
+        "#{msg}\n"
+      end
+      logger
+    end
+  end
+end