opensubtitles 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 56636430f2a77e1d25513363f97d20621023c537
+  data.tar.gz: 879215ec0a742848a2c1c43b32684742f7761f1c
+SHA512:
+  metadata.gz: 971eeb7d6fb8b304b6e687bfe24e39a19d3b463d242b2bd50e7138670a5c72c85c09b674ba39bf012bc392224f038b81f673fcf0956e5c28168064de78837101
+  data.tar.gz: 1c93a7f15b5f4eb5639eadf77a23c9c64e2c57507542af3609dbfcb822a1bc93e3bec4d8b2d385fc8aab0b32c648adcec51f94d898d6881bc822056c954916ea

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,10 @@
+rvm:
+  - 1.9.3
+#  - 2.0.1
+  - 2.1.1
+  - 2.2.1
+  - 2.2.3
+  - rbx
+  - jruby
+#  - ree
+

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jean Boussier
+
+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,50 @@
+# Opensubtitles
+
+Client library for the [Opensubtitles protocol](http://trac.opensubtitles.org/projects/opensubtitles/wiki/XMLRPC).
+Currently the implentation is limited to movie identification and subtitles search
+
+[![Build Status](https://secure.travis-ci.org/evandrojr/opensubtitles.png)](http://travis-ci.org/evandrojr/opensubtitles)
+
+## Examples
+
+Just read the source of `bin/getsub` it is a typical example of Opensubtitles's capacities.
+
+## getsub
+
+The opensubtitles gem provide a simple script to find and download the best subtitle on
+[opensubtitles.org](http://www.opensubtitles.org/) for your video file.
+
+### Installation
+
+    $ gem install opensubtitles
+
+### Usage
+
+    getsub [options] DIRECTORY | VIDEO_FILE [VIDEO_FILE ...]
+
+You just have to execute `getsub` with some video files in arguments:
+
+    $ getsub somemovie.avi othermovie.mkv
+
+Or specify a directory to search recursively:
+
+    $ getsub ~/Movies
+
+For options details just run:
+
+    $ getsub --help
+
+Main options:
+
+    -a, --auto                       Do not ask user to resolve hash conflicts.
+    
+    -l, --language LANGUAGE          Sub language ISO 639-2 code like fre or eng. Default: env $LANG (your-lang)
+    
+    -f, --force                      Download sub even if video already has one
+    
+    -t, --type FORMATS               Select only subtitles in specified formats. e.g -t srt,sub
+    
+    -L, --language-extension         Add the ISO 639-2 in the subtitle's file extension. e.g filename.eng.srt
+    
+    -s, --search-by METHODS          Ordered list of search methods. h: by movie hash, i: by name on IMDB, n: by name on Opensubtitles, p: by filename on Opensubtitles. e.g -s hi . Default: h
+

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'rake'
+require 'rspec/core/rake_task'
+require 'bundler'
+
+Bundler::GemHelper.install_tasks
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/getsub

@@ -0,0 +1,157 @@
+#!/usr/bin/env ruby
+require 'optparse'
+require 'uri'
+require 'rubygems'
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'opensubtitles'))
+
+
+class GetSub
+
+  def initialize
+    @options = {:language => Opensubtitles.default_language.to_iso639_2b, :force => false, :dir => nil, :methods => 'h', :language_extension => false }
+    @parser ||= OptionParser.new do |opts|
+      opts.banner = "Automatically download subs for your video files using opensubtitle.org"
+      opts.separator ""
+      opts.separator "Usage: getsub [options] DIRECTORY | VIDEO_FILE [VIDEO_FILE ...]"
+      opts.separator ""
+      opts.separator "Main options:"
+
+      opts.on("-a", "--auto", "Do not ask user to resolve hash conflicts.") { @options[:auto] = true }
+
+      opts.on("-l", "--language LANGUAGE", "Sub language ISO 639-2 code like fre or eng. Default: env $LANG (#{Opensubtitles.default_language.to_iso639_2b})") do |language|
+        if language.to_s.length != 3
+          STDERR.puts "Invalid argument: Language should specified as ISO 639-2 (ie, 3 letters, like 'eng' or 'fre')"
+          exit 1
+        end
+        @options[:language] = language.to_s
+      end
+
+      opts.on("-f", "--force", "Download sub even if video already has one") { @options[:force] = true }
+
+      opts.on("-t", "--type FORMATS", "Select only subtitles in specified formats. e.g -t srt,sub") { |formats| @options[:formats] = formats.to_s.split(',') }
+
+      opts.on("-L", "--language-extension", "Add the ISO 639-2 in the subtitle's file extension. e.g filename.eng.srt" ) { @options[:language_extension] = true }
+
+      methods_help = "Ordered list of search methods. h: by movie hash, i: by name on IMDB, n: by name on Opensubtitles, p: by filename on Opensubtitles. e.g -s hi . Default: h"
+      opts.on("-s", "--search-by METHODS", methods_help) do |methods|
+        unless methods =~ /^[hinp]+$/
+          STDERR.puts "Invalid argument: Available search methods are: h, i, n and p."
+          exit 1
+        end
+        @options[:methods] = methods
+      end
+
+    end
+  end
+
+  def run!(files)
+    @parser.parse!
+    language = @options[:language] if @options[:language_extension]
+
+    movie_files = glob(files).map{ |path| Opensubtitles::MovieFile.new(path, language) }
+
+    movie_files.each do |movie_file|
+      begin
+        puts "* Search subtitles for #{movie_file.name}"
+        if movie_file.has_sub? && !@options[:force]
+          puts "* Sub already there. To override it use --force"
+          puts
+          next
+        end
+
+        if sub = subtitle_finder.find_sub_for(movie_file, @options[:language])
+          download_sub!(sub, movie_file)
+        else
+          puts "* No sub found"
+        end
+        puts
+      rescue Exception => e
+        report_exception(e)
+      end
+    end
+  end
+
+  def glob(files)
+    files.map do |path|
+      if File.directory?(path)
+        Dir.chdir(path) do # chdir to avoid escaping special chars in path
+          relative_paths = Dir.glob("**/*.{#{Opensubtitles::MovieFile::EXTENSIONS.join(',')}}")
+          return relative_paths.map{ |f| File.join(path, f) }
+        end
+      else
+        path
+      end
+    end.flatten
+  end
+
+  def report_exception(exception)
+    puts
+    puts "Something crashed."
+    puts "Feel free to report the error here: https://github.com/byroot/opensubtitles/issues"
+    puts "With the following debug informations:"
+    puts
+    puts "#{exception.class.name}: #{exception.message}:"
+    puts exception.backtrace
+    puts
+  end
+
+  def subtitle_finder
+    @subtitle_finder ||= Opensubtitles::SubtitleFinder.new(search_engines, finders, selectors)
+  end
+
+  SEARCH_ENGINES = {
+    'h' => Opensubtitles::Search::MovieHash,
+    'i' => Opensubtitles::Search::IMDB,
+    'n' => Opensubtitles::Search::Name,
+    'p' => Opensubtitles::Search::Path
+  }
+
+  def search_engines
+    @options[:methods].to_s.each_char.to_a.uniq.map do |char|
+      SEARCH_ENGINES[char.to_s].new(server)
+    end
+  end
+
+  def finders
+    [Opensubtitles::Finder::Score.new]
+  end
+
+  def selectors
+    movie_finder = if @options[:auto]
+      Opensubtitles::Finder::First.new # TODO: try to match subtitle movie name with filename
+    else
+      Opensubtitles::Finder::Interactive.new
+    end
+    
+    selectors = [
+      Opensubtitles::Selector::Movie.new(movie_finder)
+    ]
+    selectors << Opensubtitles::Selector::Format.new(@options[:formats]) if @options[:formats]
+    selectors
+  end
+
+  def server
+    @server ||= Opensubtitles::Server.new(
+      :timeout => 90, 
+      :useragent => "SubDownloader 2.0.10" # register useragent ? WTF ? too boring.
+    ) 
+  end
+
+  def download_sub!(sub, movie_file)
+    local_path = movie_file.sub_path(sub.format)
+    print "* download #{sub.url} to #{local_path} ... "
+    content = sub.body
+    unless content
+      puts "failed"
+      return
+    end
+
+    File.open(movie_file.sub_path(sub.format), 'w+') do |file|
+      file.write(content)
+    end
+    puts "done"
+  end
+
+end
+
+GetSub.new.run!(ARGV)

data/lib/opensubtitles.rb

@@ -0,0 +1,21 @@
+require 'xmlrpc/client'
+
+module Opensubtitles
+  base_path = File.expand_path(File.dirname(__FILE__) + '/opensubtitles')
+  require "#{base_path}/xmlrpc_monkey_patch"
+
+  autoload :Finder,         "#{base_path}/finder"
+  autoload :Language,       "#{base_path}/language"
+  autoload :Movie,          "#{base_path}/movie"
+  autoload :MovieFile,      "#{base_path}/movie_file"
+  autoload :Search,         "#{base_path}/search"
+  autoload :Selector,       "#{base_path}/selector"
+  autoload :Server,         "#{base_path}/server"
+  autoload :Sub,            "#{base_path}/sub"
+  autoload :SubtitleFinder, "#{base_path}/subtitle_finder"
+
+  def self.default_language
+    Opensubtitles::Language.from_locale(ENV['LANG'] || 'en_US.UTF-8')
+  end
+
+end

data/lib/opensubtitles/finder.rb

@@ -0,0 +1,8 @@
+module Opensubtitles
+  module Finder
+    base_path = File.expand_path(File.dirname(__FILE__) + '/finder')
+    autoload :First,       "#{base_path}/first"
+    autoload :Interactive, "#{base_path}/interactive"
+    autoload :Score,       "#{base_path}/score"
+  end
+end

data/lib/opensubtitles/finder/first.rb

@@ -0,0 +1,13 @@
+module Opensubtitles
+  module Finder
+
+    class First
+
+      def chose(items)
+        items.first
+      end
+
+    end
+
+  end
+end

data/lib/opensubtitles/finder/interactive.rb

@@ -0,0 +1,21 @@
+module Opensubtitles
+  module Finder
+
+    class Interactive
+
+      def chose(items)
+        puts "D'oh! You stumbled upon a hash conflict, please resolve it:"
+        puts
+        items.each_with_index do |name, index|
+          puts " #{index} - #{name}"
+        end
+        print 'id: '
+        str = STDIN.gets # TODO: rule #1, never trust user input
+        puts
+        items[str.to_i]
+      end
+
+    end
+
+  end
+end

data/lib/opensubtitles/finder/score.rb

@@ -0,0 +1,13 @@
+module Opensubtitles
+  module Finder
+
+    class Score
+
+      def chose(items)
+        items.max_by(&:score)
+      end
+
+    end
+
+  end
+end

data/lib/opensubtitles/language.rb

@@ -0,0 +1,84 @@
+module Opensubtitles
+  
+  LANGUAGES = [ 
+    {:iso639_1 => 'sq', :iso639_2b => 'alb', :locale => 'sq', :name => 'Albanian'},
+    {:iso639_1 => 'ar', :iso639_2b => 'ara', :locale => 'ar', :name => 'Arabic'},
+    {:iso639_1 => 'hy', :iso639_2b => 'arm', :locale => 'hy', :name => 'Armenian'},
+    {:iso639_1 => 'ms', :iso639_2b => 'may', :locale => 'ms', :name => 'Malay'},
+    {:iso639_1 => 'bs', :iso639_2b => 'bos', :locale => 'bs', :name => 'Bosnian'},
+    {:iso639_1 => 'bg', :iso639_2b => 'bul', :locale => 'bg', :name => 'Bulgarian'},
+    {:iso639_1 => 'ca', :iso639_2b => 'cat', :locale => 'ca', :name => 'Catalan'},
+    {:iso639_1 => 'eu', :iso639_2b => 'eus', :locale => 'eu', :name => 'Basque'},
+    {:iso639_1 => 'zh', :iso639_2b => 'chi', :locale => 'zh_CN', :name => 'Chinese (China)'},
+    {:iso639_1 => 'hr', :iso639_2b => 'hrv', :locale => 'hr', :name => 'Croatian'},
+    {:iso639_1 => 'cs', :iso639_2b => 'cze', :locale => 'cs', :name => 'Czech'},
+    {:iso639_1 => 'da', :iso639_2b => 'dan', :locale => 'da', :name => 'Danish'},
+    {:iso639_1 => 'nl', :iso639_2b => 'dut', :locale => 'nl', :name => 'Dutch'},
+    {:iso639_1 => 'en', :iso639_2b => 'eng', :locale => 'en', :name => 'English (US)'},
+    {:iso639_1 => 'en', :iso639_2b => 'bre', :locale => 'en_GB', :name => 'English (UK)'},
+    {:iso639_1 => 'eo', :iso639_2b => 'epo', :locale => 'eo', :name => 'Esperanto'},
+    {:iso639_1 => 'et', :iso639_2b => 'est', :locale => 'et', :name => 'Estonian'},
+    {:iso639_1 => 'fi', :iso639_2b => 'fin', :locale => 'fi', :name => 'Finnish'},
+    {:iso639_1 => 'fr', :iso639_2b => 'fre', :locale => 'fr', :name => 'French'},
+    {:iso639_1 => 'gl', :iso639_2b => 'glg', :locale => 'gl', :name => 'Galician'},
+    {:iso639_1 => 'ka', :iso639_2b => 'geo', :locale => 'ka', :name => 'Georgian'},
+    {:iso639_1 => 'de', :iso639_2b => 'ger', :locale => 'de', :name => 'German'},
+    {:iso639_1 => 'el', :iso639_2b => 'ell', :locale => 'el', :name => 'Greek'},
+    {:iso639_1 => 'he', :iso639_2b => 'heb', :locale => 'he', :name => 'Hebrew'},
+    {:iso639_1 => 'hu', :iso639_2b => 'hun', :locale => 'hu', :name => 'Hungarian'},
+    {:iso639_1 => 'id', :iso639_2b => 'ind', :locale => 'id', :name => 'Indonesian'},
+    {:iso639_1 => 'it', :iso639_2b => 'ita', :locale => 'it', :name => 'Italian'},
+    {:iso639_1 => 'ja', :iso639_2b => 'jpn', :locale => 'ja', :name => 'Japanese'},
+    {:iso639_1 => 'kk', :iso639_2b => 'kaz', :locale => 'kk', :name => 'Kazakh'},
+    {:iso639_1 => 'ko', :iso639_2b => 'kor', :locale => 'ko', :name => 'Korean'},
+    {:iso639_1 => 'lv', :iso639_2b => 'lav', :locale => 'lv', :name => 'Latvian'},
+    {:iso639_1 => 'lt', :iso639_2b => 'lit', :locale => 'lt', :name => 'Lithuanian'},
+    {:iso639_1 => 'lb', :iso639_2b => 'ltz', :locale => 'lb', :name => 'Luxembourgish'},
+    {:iso639_1 => 'mk', :iso639_2b => 'mac', :locale => 'mk', :name => 'Macedonian'},
+    {:iso639_1 => 'no', :iso639_2b => 'nor', :locale => 'no', :name => 'Norwegian'},
+    {:iso639_1 => 'fa', :iso639_2b => 'per', :locale => 'fa', :name => 'Persian'},
+    {:iso639_1 => 'pl', :iso639_2b => 'pol', :locale => 'pl', :name => 'Polish'},
+    {:iso639_1 => 'pt', :iso639_2b => 'por', :locale => 'pt_PT', :name => 'Portuguese (Portugal)'},
+    {:iso639_1 => 'pb', :iso639_2b => 'pob', :locale => 'pt_BR', :name => 'Portuguese (Brazil)'},
+    {:iso639_1 => 'ro', :iso639_2b => 'rum', :locale => 'ro', :name => 'Romanian'},
+    {:iso639_1 => 'ru', :iso639_2b => 'rus', :locale => 'ru', :name => 'Russian'},
+    {:iso639_1 => 'sr', :iso639_2b => 'scc', :locale => 'sr', :name => 'Serbian'},
+    {:iso639_1 => 'sk', :iso639_2b => 'slo', :locale => 'sk', :name => 'Slovak'},
+    {:iso639_1 => 'sl', :iso639_2b => 'slv', :locale => 'sl', :name => 'Slovenian'},
+    {:iso639_1 => 'es', :iso639_2b => 'spa', :locale => 'es_ES', :name => 'Spanish (Spain)'},
+    {:iso639_1 => 'sv', :iso639_2b => 'swe', :locale => 'sv', :name => 'Swedish'},
+    {:iso639_1 => 'th', :iso639_2b => 'tha', :locale => 'th', :name => 'Thai'},
+    {:iso639_1 => 'tr', :iso639_2b => 'tur', :locale => 'tr', :name => 'Turkish'},
+    {:iso639_1 => 'uk', :iso639_2b => 'ukr', :locale => 'uk', :name => 'Ukrainian'},
+    {:iso639_1 => 'vi', :iso639_2b => 'vie', :locale => 'vi', :name => 'Vietnamese'}
+  ]
+  
+  class Language
+    
+    class << self
+      
+      def from_locale(locale)
+        locale = locale.split('.').first
+        lang = LANGUAGES.find{ |lang| lang[:locale] == locale }
+        return from_locale(locale.split('_').first) if !lang && locale.include?('_')
+        new(lang)
+      end
+      
+      def from_iso639_2b(code)
+        new(LANGUAGES.find{ |lang| lang[:iso639_2b] == code })
+      end
+      
+    end
+    
+    attr_reader :name, :to_iso639_1, :to_iso639_2b, :to_locale
+    
+    def initialize(hash)
+      @name = hash[:name]
+      @to_iso639_1 = hash[:iso639_1]
+      @to_iso639_2b = hash[:iso639_2b]
+      @to_locale = hash[:locale]
+    end
+    
+  end
+  
+end

data/lib/opensubtitles/movie.rb

@@ -0,0 +1,16 @@
+module Opensubtitles
+  class Movie
+
+    attr_reader :id, :title, :year, :cover, :rating, :raw_data
+
+    def initialize(data)
+      @id = data['id']
+      @title = data['title']
+      @year = data['year'] && data['year'].to_i
+      @cover = data['cover']
+      @rating = data['rating'] && data['rating'].to_f
+      @raw_data = data
+    end
+
+  end
+end