subs 1.0.0

data/lib/subs/providers/provider.rb

@@ -0,0 +1,58 @@
+module Subs
+
+  class Provider
+
+    attr_reader :name
+    attr_reader :uri
+    attr_reader :user_agent
+
+    def initialize(name, uri, user_agent)
+      @name = name
+      @uri = uri.is_a?(String) ? URI(uri) : uri
+      @user_agent = user_agent
+    end
+
+    def process_result(io, result)
+      Subs.log.debug { "Processing '#{result.name}'"}
+      unless self.is_a?(result.provider)
+        Subs.log.error { "#{@name} cannot process #{result.provider_name} result"}
+        return false
+      end
+      true
+    end
+  end
+
+  module CredentialProvider
+  end
+
+  module HashSearcher
+
+    def compute_hash(path)
+    end
+
+    def hash_search(path, *languages)
+      Array.new
+    end
+  end
+
+  module LoginProvider
+
+    def login(username, password)
+      false
+    end
+  end
+
+  module FilenameSearcher
+
+    def filename_search(path, *larnguages)
+      Array.new
+    end
+  end
+
+  module IMDbSearcher
+
+    def imdb_search(path, imdb_code, *languages)
+      Array.new
+    end
+  end
+end

data/lib/subs/providers/sub_db.rb

@@ -0,0 +1,80 @@
+
+module Subs
+
+  class SubDB < Provider
+
+    include HashSearcher
+
+    def initialize(&block)
+      agent = "SubDB/1.0 (subs/#{Subs::VERSION}; http://github.com/ForeverZer0/subs)"
+      super('TheSubDB.com', URI('http://api.thesubdb.com/'), agent)
+      yield self if block_given?
+    end
+
+    def compute_hash(path)
+      size = 64 * 1024
+      File.open(path, 'rb') do |io|
+        buffer = io.read(size)
+        io.seek(-size, IO::SEEK_END)
+        buffer << io.read
+        return Digest::MD5.hexdigest(buffer)
+      end
+    end
+
+    def process_result(io, result)
+      return false unless super
+      hash = result.data
+      lang = result.language.alpha2
+      request = Net::HTTP::Get.new(@uri.path + Subs.query_string(action: :download, hash: hash, language: lang ))
+      request['User-Agent'] = @user_agent
+      begin
+        Net::HTTP.start(@uri.host, @uri.port) do |net|
+          response = net.request(request)
+          return false unless response.code.to_i == 200
+          io.write(response.body)
+          Subs.log.debug { 'Success'.green }
+          return true
+        end
+      rescue
+        Subs.log.debug { 'Failed'.red }
+        return false
+      end
+    end
+
+    def hash_search(path, *languages)
+      results = []
+      unless File.exist?(path)
+        Subs.log.error { "Cannot search, cannot find '#{path}'" }
+        return results
+      end
+      hash = compute_hash(path)
+      Subs.log.debug { "Searching #{@name.blue} by hash using '#{hash}'" }
+      supported = supported_languages(hash)
+      languages.each do |language|
+        next unless supported.include?(language)
+        name = File.basename(Subs.build_subtitle_path(path, language))
+        results << Subs::SearchResult.new(@name, self.class, name, language, path, hash)
+      end
+      Subs.log.debug { "Found #{results.size.to_s.light_blue} result(s)." }
+      results
+    end
+
+    def supported_languages(hash)
+      request = Net::HTTP::Get.new(@uri.path + Subs.query_string(action: 'search', hash: hash))
+      request['User-Agent'] = @user_agent
+      Net::HTTP.start(@uri.host, @uri.port) do |net|
+        body = net.request(request).body
+        body.split(',').map { |value| Subs::Language.from_alpha2(value) }.compact
+      end
+    end
+
+    def all_supported_languages
+      request = Net::HTTP::Get.new(@uri.path + Subs.query_string(action: 'languages'))
+      request['User-Agent'] = @user_agent
+      Net::HTTP.start(@uri.host, @uri.port) do |net|
+        body = net.request(request).body
+        body.split(',').map { |value| Subs::Language.from_alpha2(value) }.compact
+      end
+    end
+  end
+end

data/lib/subs/sub_rip_time.rb

@@ -0,0 +1,47 @@
+module Subs
+  class SubRipTime
+
+    def initialize(hour, minute, second, millisecond)
+      @ms = millisecond
+      @ms += second * 1000
+      @ms += minute * 60 * 1000
+      @ms += hour * 60 * 60 * 1000
+    end
+
+    ZERO = SubRipTime.new(0, 0, 0, 0).freeze
+
+    def total_ms
+      @ms
+    end
+
+    def -(amount)
+      value = amount.is_a?(SubRipTime) ? amount.total_ms : Integer(amount)
+      self.class.new(0, 0, 0, [@ms - value, 0].max)
+    end
+
+    def +(amount)
+      value = amount.is_a?(SubRipTime) ? amount.total_ms : Integer(amount)
+      self.class.new(0, 0, 0, [@ms + value, 0].max)
+    end
+
+    def hours
+      @ms / (1000 * 60 * 60)
+    end
+
+    def minutes
+      (@ms / (1000 * 60)) % 60
+    end
+
+    def seconds
+      (@ms / 1000) % 60
+    end
+
+    def milliseconds
+      @ms % 1000
+    end
+
+    def to_s
+      "%02d:%02d:%02d,%03d" % [hours, minutes, seconds, milliseconds]
+    end
+  end
+end

data/lib/subs/version.rb

@@ -0,0 +1,4 @@
+module Subs
+
+  VERSION = "1.0.0"
+end

data/lib/subs.rb

@@ -0,0 +1,192 @@
+require 'open-uri'
+require 'zlib'
+require 'digest'
+require 'net/http'
+require 'cgi'
+require 'set'
+
+require_relative 'subs/version'
+require_relative 'subs/language'
+require_relative 'subs/sub_rip_time'
+require_relative 'subs/providers/provider'
+require_relative 'subs/providers/sub_db'
+require_relative 'subs/providers/open_subtitles'
+
+class String
+
+  # Defines methods for displaying colorized console output, unless already provided by another gem.
+
+  [:red, :green, :yellow, :blue, :pink, :light_blue].each_with_index do |color, i|
+    next if method_defined?(color)
+    class_eval("def #{color};\"\e[#{i + 31}m\#{self}\e[0m\";end", __FILE__ , __LINE__ )
+  end
+
+  ##
+  # @!method red
+  #   @return [String]
+
+  ##
+  # @!method green
+  #   @return [String]
+
+  ##
+  # @!method yellow
+  #   @return [String]
+
+  ##
+  # @!method blue
+  #   @return [String]
+
+  ##
+  # @!method pink
+  #   @return [String]
+
+  ##
+  # @!method light_blue
+  #   @return [String]
+end
+
+##
+# Top-level namespace for the gem.
+module Subs
+
+  ##
+  # Represents a generic search result for a subtitle
+  SearchResult = Struct.new(:provider_name, :provider, :name, :language, :video, :data)
+
+  ##
+  # Represent a movie.
+  Movie = Struct.new(:name, :year, :imdb)
+
+  ##
+  # Video extensions to search for.
+  VIDEO_EXTENSIONS = %w(.avi .mkv .mp4 .mov .mpg .wmv .rm .rmvb .divx).freeze
+
+  ##
+  # Subtitle extensions to search for.
+  SUB_EXTENSIONS = %w(.srt .sub).freeze
+
+  ##
+  # Creates the logger with the specified output stream and verbosity level.
+  #
+  # @param io [IO] An IO instance that can be written to.
+  # @param verbosity [:info|:warn|:error|:fatal|:debug] The logger verbosity level.
+  #
+  # @return [Logger] the created Logger instance.
+  def self.create_log(io = STDOUT, verbosity = :info)
+    unless @log
+      require 'logger'
+      @log = Logger.new(io)
+      @log.formatter = proc do |severity, datetime, _, msg|
+        "[%s] %s -- %s\n" % [datetime.strftime('%Y-%m-%d %H:%M:%S'), severity, msg]
+      end
+      @log.level = case verbosity
+      when :warn then Logger::WARN
+      when :error then Logger::ERROR
+      when :fatal then Logger::FATAL
+      when :debug then Logger::DEBUG
+      else Logger::INFO
+      end
+    end
+    @log
+  end
+
+  ##
+  # @return [Logger] the logger instance for the module.
+  def self.log
+    @log ||= create_log(STDOUT)
+  end
+
+  ##
+  # Searches the specified directory for supported video files.
+  #
+  # @param directory [String] Path to a directory to search.
+  # @param recursive [Boolean] `true` to search recursively within nested directories, otherwise `false`.
+  #
+  # @return [Array<String>] paths to all found video files.
+  #
+  def self.video_search(directory, recursive)
+    VIDEO_EXTENSIONS.flat_map do |ext|
+      Dir.glob(File.join(directory, recursive ? "**/*#{ext}" : "*#{ext}"))
+    end
+  end
+
+  ##
+  # Checks the specified video file for the existence of a subtitles, using common naming conventions and optional
+  # language.
+  #
+  # @param video_path [String] The path to the video file to check.
+  # @param language [Language] A specific language to check.
+  #
+  # @return [Boolean] `true` if a matching subtitle was found, otherwise `false`.
+  #
+  def self.subtitle_exist?(video_path, language = nil)
+    dir = File.dirname(video_path)
+    # ex. '/home/me/Videos/MyFavoriteMovie.2019.mp4' => 'MyFavoriteMovie.2019'
+    base = File.basename(video_path, File.extname(video_path))
+    # Check each supported subtitle extension
+    SUB_EXTENSIONS.each do |ext|
+      # ex. MyFavoriteMovie.2019.srt
+      return true if File.exist?(File.join(dir, "#{base}#{ext}"))
+      next unless language
+      if language.alpha2
+        # ex. MyFavoriteMovie.2019.en.srt
+        return true if File.exist?(File.join(dir, "#{base}.#{language.alpha2}#{ext}"))
+      end
+      # ex. MyFavoriteMovie.2019.eng.srt
+      return true if File.exist?(File.join(dir, "#{base}.#{language.alpha3}#{ext}"))
+    end
+    # Not found
+    false
+  end
+
+  ##
+  # Creates a query string to be used within a URI based on specified parameters.
+  #
+  # @param params [Hash<Symbol, Object>] A hash of keyword arguments that are used to build the query.
+  #
+  # @return [String] The constructed query string.
+  def self.query_string(**params)
+    query = ''
+    params.each_pair do |key, value|
+      next unless value
+      query << (query.size.zero? ? '?' : '&')
+      query << CGI.escape(key.to_s)
+      query << '='
+      query << CGI.escape(value.to_s)
+    end
+    query
+  end
+
+  ##
+  # Convenience method to attempt getting basic movie information with the specified file.
+  #
+  # @param path [String] A path to a video file.
+  #
+  # @return [Movie?] Movie information with result, or `nil` if none could be found.
+  def self.fuzzy_search(path)
+    return nil unless  File.exist?(path)
+    result = nil
+    OpenSubtitles.new { |provider| result = provider.fuzzy_search(File.basename(path)) }
+    result
+  end
+
+  ##
+  # Uses the path of a video file to create a path to a matching subtitle file.
+  #
+  # @param path [String] The path to the video file.
+  # @param language [Language] A language for applying a 3-letter language suffix to the file, or `nil` to omit suffix.
+  # @param ext [String] The language file extension, including leading dot.
+  #
+  # @return [String] The created subtitle path.
+  def self.build_subtitle_path(path, language = nil, ext = '.srt')
+    dir = File.dirname(path)
+    base = File.basename(path, File.extname(path))
+    if language
+      File.join(dir, "#{base}.#{language.alpha3}#{ext}")
+    else
+      File.join(dir, "#{base}#{ext}")
+    end
+  end
+end
+

data/subs.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'subs/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'subs'
+  spec.version       = Subs::VERSION
+  spec.authors       = ['ForeverZer0']
+  spec.email         = ['efreed09@gmail.com']
+
+  spec.summary       = %q{Simple and intuitive command-line program to automatically and accurately search and download subtitles for all of your favorite movies and television shows.}
+  spec.description   = %q{Simple and intuitive command-line program to automatically and accurately search and download subtitles for all of your favorite movies and television shows. Utilizes multiple providers search algorithms ensure you always get the best result, and includes tools to resync SubRip files with ease.}
+  spec.homepage      = 'https://github.com/ForeverZer0/subs'
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'xmlrpc',  '~> 0.3'
+  spec.add_runtime_dependency 'thor',    '~> 0.20'
+
+  spec.add_development_dependency 'bundler',  '~> 2.0'
+  spec.add_development_dependency 'rake',     '~> 10.0'
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: subs
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- ForeverZer0
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-05-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: xmlrpc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Simple and intuitive command-line program to automatically and accurately
+  search and download subtitles for all of your favorite movies and television shows.
+  Utilizes multiple providers search algorithms ensure you always get the best result,
+  and includes tools to resync SubRip files with ease.
+email:
+- efreed09@gmail.com
+executables:
+- subs
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/subs
+- lib/subs.rb
+- lib/subs/language.rb
+- lib/subs/providers/open_subtitles.rb
+- lib/subs/providers/provider.rb
+- lib/subs/providers/sub_db.rb
+- lib/subs/sub_rip_time.rb
+- lib/subs/version.rb
+- subs.gemspec
+homepage: https://github.com/ForeverZer0/subs
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Simple and intuitive command-line program to automatically and accurately
+  search and download subtitles for all of your favorite movies and television shows.
+test_files: []