osdb 0.0.9 → 0.0.10

data/.travis.yml

@@ -0,0 +1,9 @@
+rvm:
+  - 1.8.7 # (current default)
+  - 1.9.2
+  - 1.9.3
+  - rbx
+  - jruby
+  - ruby-head
+  - ree
+

data/README.md

@@ -3,6 +3,8 @@
 Client library for the [OSDb 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/byroot/ruby-osdb.png)](http://travis-ci.org/byroot/ruby-osdb)
+
 ## Examples
 
 Just read the source of `bin/getsub` it is a typical example of OSDb's capacities.

data/bin/getsub

@@ -16,16 +16,23 @@ end
   opts.separator "Usage: getsub [options] DIRECTORY | VIDEO_FILE [VIDEO_FILE ...]"
   opts.separator ""
   opts.separator "Main options:"
-  
-  opts.on("-l", "--language LANGUAGE", "Sub language ISO 963 code like fre or eng. Default: env $LANG (#{env_lang.to_iso639_2b})") do |language|
-    @options[:language] = language
+
+  opts.on("-l", "--language LANGUAGE", "Sub language ISO 639-2 code like fre or eng. Default: env $LANG (#{env_lang.to_iso639_2b})") do |language|
+    if language.to_s.length != 3
+      STDERR.puts "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("-d", "--directory DIRECTORY", "Specify a directory to search recursively for movies") do |dir|
     @options[:dir] = dir
   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(',') }
+
 end
 @parser.parse!
 
@@ -66,44 +73,34 @@ def ask_user_to_identify_movie(movies)
   print 'id: '
   str = STDIN.gets # TODO: rule #1, never trust user input
   puts
-  movies[movies.keys[str.to_i]]
+  movies[movies.keys[str.to_i]] || []
 end
 
-def identify_by_imdb!(server, movie)
-  puts "* could not find sub by hash, trying IMDB"
-  imdb_results = server.search_imdb(:query => movie.name)
-  if imdb_results.any?
-    if imdb_results.length == 1
-      imdb_result = imdb_results.first
-      puts "* found on IMDB with ID: #{imdb_result.imdbid}"
-    else
-      movies = Hash[imdb_results.map{ |r| [r.title, r] }]
-      imdb_result = ask_user_to_identify_movie(movies)
-    end
-    subs = server.search_subtitles(:sublanguageid => @options[:language], :imdbid => imdb_result.imdbid)
-    if subs.any?
-      select_and_download!(subs, movie)
-    else
-      puts "* no sub found for this movie"
-    end
-  else
-    puts "* no movie found on IMDB"
-  end
+def normalize_name(name)
+  name.downcase.gsub(/[\s\.\-\_]+/, ' ')
 end
 
-def select_sub(subs)
-  return subs.first if subs.length >= 1
-  movies = group_by_movie_name(subs)
-  return movies.values.first.max if movies.length == 1
+def select_movie(movies)
+  return movies.values.first || [] if movies.length <= 1
 
   puts "D'oh! You stumbled upon a hash conflict, please resolve it:"
   puts
-  selected_movie_subs = ask_user_to_identify_movie(movies)
-  selected_movie_subs.max
+  ask_user_to_identify_movie(movies)
+end
+
+def select_format(subs)
+  return subs unless @options[:formats]
+  subs.select{ |s| @options[:formats].include?(s.format) }
+end
+
+def select_sub(subs)
+  subs = select_format(subs)
+  movies = group_by_movie_name(subs)
+  subs = select_movie(movies)
+  subs.max_by(&:score)
 end
 
-def select_and_download!(subs, movie)
-  sub = select_sub(subs)
+def download_sub!(sub, movie)
   sub_path = movie.sub_path(sub.format)
   download!(sub.url, sub_path)
 end
@@ -130,17 +127,70 @@ if movies.empty?
   exit 1
 end
 
+def search_by_hash(server, movie)
+  server.search_subtitles(:moviehash => movie.hash, :moviebytesize => movie.size.to_s, :sublanguageid => @options[:language])
+end
+
+def search_by_path(server, movie)
+  server.search_subtitles(:sublanguageid => @options[:language], :tag => movie.path)
+end
+
+def search_by_name(server, movie)
+  subs = server.search_subtitles(:sublanguageid => @options[:language], :query => movie.name)
+  normalized_movie_name = normalize_name(movie.name)
+  subs.select! do |sub|
+    normalize_name(sub.filename).index(normalized_movie_name) # MAYBE: Levenshtein ?
+  end
+  subs if subs.any?
+end
+
+def search_by_imdb(server, movie)
+  imdb_results = server.search_imdb(:query => movie.name)
+  if imdb_results.any?
+    if imdb_results.length == 1
+      imdb_result = imdb_results.first
+      puts "* found on IMDB with ID: #{imdb_result.imdbid}"
+    else
+      movies = Hash[imdb_results.map{ |r| [r.title, r] }]
+      imdb_result = ask_user_to_identify_movie(movies)
+    end
+    server.search_subtitles(:sublanguageid => @options[:language], :imdbid => imdb_result.imdbid)
+  end
+end
+
 movies.each do |movie|
   begin
-    puts "* search subs for: #{movie.path}"
-    subs = server.search_subtitles(:moviehash => movie.hash, :moviebytesize => movie.size.to_s, :sublanguageid => @options[:language])
-    if subs.any?
-      select_and_download!(subs, movie)
+    puts "* search subs by hash for: #{movie.path}"
+    sub = select_sub search_by_hash(server, movie)
+
+    unless sub
+      puts "* could not find sub by hash, trying IMDB"
+      sub = select_sub search_by_imdb(server, movie)
+    end
+
+    unless sub
+      puts "* no matches"
+      puts "* search subs by path"
+      sub = select_sub search_by_path(server, movie)
+    end
+
+    unless sub
+      puts "* still no matches"
+      puts "* search subs by filename"
+      sub = select_sub search_by_name(server, movie)
+    end
+
+    if sub
+      download_sub!(sub, movie)
     else
-      identify_by_imdb!(server, movie)
+      puts "Nothing worked, you are very unlucky :'("
     end
     puts
   rescue Exception => e
+    puts "Something crashed."
+    puts "Feel free to report the error here: https://github.com/byroot/ruby-osdb/issues"
+    puts "With the following debug informations:"
+    puts
     puts "#{e.class.name}: #{e.message}:"
     puts e.backtrace
   end

data/lib/osdb/sub.rb

@@ -1,24 +1,40 @@
 require 'uri'
 
 module OSDb
-  
+
   class Sub
-    
-    attr_reader :url, :format, :language, :rating, :movie_name, :raw_data
-    
+
+    attr_reader :url, :format, :language, :rating, :user_ranks, :movie_name,
+      :filename, :raw_data, :downloads_count, :bad_reports_count
+
     def initialize(data)
       @url = URI.parse(data['SubDownloadLink'])
       @format = data['SubFormat']
       @language = Language.from_iso639_2b(data['SubLanguageID'])
       @rating = data['SubRating'].to_f
+      @user_ranks = data['UserRank']
       @movie_name = data['MovieName']
+      @filename = data['SubFileName']
+      @downloads_count = data['SubDownloadsCnt'].to_i
+      @bad_reports_count = data['SubBad'].to_i
       @raw_data = data
     end
-    
+
     def <=>(other)
       rating <=> other.rating
     end
-    
+
+    # Totaly subjective formula to evaluate subtitle quality
+    # Originaly developed by runa (https://github.com/runa)
+    # https://github.com/byroot/ruby-osdb/commit/9d71775#L0R122
+    def score
+      uploader_score * downloads_count.next * (rating + 1) - bad_reports_count / downloads_count.next
+    end
+
+    def uploader_score
+      user_ranks.empty? ? 1 : 2
+    end
+
   end
-  
-end
+
+end

data/lib/osdb/version.rb

@@ -1,3 +1,3 @@
 module OSDb
-  VERSION = '0.0.9'
+  VERSION = '0.0.10'
 end

data/osdb.gemspec

@@ -17,5 +17,6 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
+  s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: osdb
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-12 00:00:00.000000000 Z
+date: 2012-08-26 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70311392052000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70311392052000
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70099189686620 !ruby/object:Gem::Requirement
+  requirement: &70311392067940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70099189686620
+  version_requirements: *70311392067940
 description: 
 email:
 - jean.boussier @nospam@ gmail.com
@@ -32,6 +43,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - README.md
 - Rakefile