bartzon-osdb 0.0.6

data/Manifest

@@ -0,0 +1,17 @@
+Manifest
+README.md
+Rakefile
+bin/getsub
+lib/osdb.rb
+lib/osdb/language.rb
+lib/osdb/movie.rb
+lib/osdb/options.rb
+lib/osdb/server.rb
+lib/osdb/sub.rb
+osdb.gemspec
+spec/fixtures/somemovie.avi
+spec/osdb/language_spec.rb
+spec/osdb/movie_spec.rb
+spec/osdb/server_spec.rb
+spec/osdb/sub_spec.rb
+spec/spec_helper.rb

data/README.md

@@ -0,0 +1,31 @@
+# OSDb
+
+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
+
+## Examples
+
+Just read the source of `bin/getsub` it is a typical example of OSDb's capacities.
+
+## getsub
+
+The osdb 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 bartzon-osdb
+
+### Usage
+
+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 -d ~/Movies
+
+For options details just run:
+
+    $ getsub --help

data/Rakefile

@@ -0,0 +1,25 @@
+require 'rubygems'
+require 'rake'
+require 'spec/rake/spectask'
+
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+begin
+  require 'echoe'
+  
+  Echoe.new('bartzon-osdb', '0.0.6') do |p|
+    p.description    = "Ruby library to access OSDb services like OpenSubtitles.org"
+    p.url            = "http://github.com/bartzon/ruby-osdb"
+    p.author         = "Jean Boussier, Bart Zonneveld"
+    p.email          = "jean.boussier @nospam@ gmail.com, loop@superinfinite.com"
+  end
+  
+rescue LoadError => e
+  puts "Failed to load Echoe"
+  puts e.message
+end
+
+task :default => :spec

data/bartzon-osdb.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{bartzon-osdb}
+  s.version = "0.0.6"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jean Boussier, Bart Zonneveld"]
+  s.date = %q{2010-12-09}
+  s.default_executable = %q{getsub}
+  s.description = %q{Ruby library to access OSDb services like OpenSubtitles.org}
+  s.email = %q{jean.boussier @nospam@ gmail.com, loop@superinfinite.com}
+  s.executables = ["getsub"]
+  s.extra_rdoc_files = ["README.md", "bin/getsub", "lib/osdb.rb", "lib/osdb/language.rb", "lib/osdb/movie.rb", "lib/osdb/options.rb", "lib/osdb/server.rb", "lib/osdb/sub.rb"]
+  s.files = ["Manifest", "README.md", "Rakefile", "bin/getsub", "lib/osdb.rb", "lib/osdb/language.rb", "lib/osdb/movie.rb", "lib/osdb/options.rb", "lib/osdb/server.rb", "lib/osdb/sub.rb", "osdb.gemspec", "spec/fixtures/somemovie.avi", "spec/osdb/language_spec.rb", "spec/osdb/movie_spec.rb", "spec/osdb/server_spec.rb", "spec/osdb/sub_spec.rb", "spec/spec_helper.rb", "bartzon-osdb.gemspec"]
+  s.homepage = %q{http://github.com/bartzon/ruby-osdb}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Bartzon-osdb", "--main", "README.md"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{bartzon-osdb}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Ruby library to access OSDb services like OpenSubtitles.org}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/bin/getsub

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+STDOUT.sync = true
+
+require 'optparse'
+require 'uri'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'osdb')
+
+OSDb::Sub.fetch_all

data/lib/osdb.rb

@@ -0,0 +1,37 @@
+require 'xmlrpc/client'
+
+module OSDb
+  base_path = File.expand_path(File.dirname(__FILE__) + '/osdb')
+  autoload :Language,  "#{base_path}/language"
+  autoload :Movie,     "#{base_path}/movie"
+  autoload :Server,    "#{base_path}/server"
+  autoload :Sub,       "#{base_path}/sub"
+  autoload :Options,   "#{base_path}/options"
+
+  def self.log(str='')
+    puts str unless options[:silent]
+  end
+  
+  def self.options
+    @@options ||= OSDb::Options.parse_options
+  end
+  
+  def self.curl_available?
+    %x{ curl --version 2> /dev/null > /dev/null }
+    $?.success?
+  end
+
+  def self.wget_available?
+    %x{ wget --version 2> /dev/null > /dev/null }
+    $?.success?
+  end
+  
+  def self.server
+    @@server ||= OSDb::Server.new(
+      :host => 'api.opensubtitles.org', 
+      :path => '/xml-rpc', 
+      :timeout => 90, 
+      :useragent => "SubDownloader 2.0.10" # register useragent ? WTF ? too boring.
+    ) 
+  end
+end

data/lib/osdb/language.rb

@@ -0,0 +1,84 @@
+module OSDb
+  
+  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/osdb/movie.rb

@@ -0,0 +1,81 @@
+module OSDb
+  class Movie
+    
+    attr_reader :path
+
+    class << self
+      def get_movie_list
+
+        if dir = OSDb.options[:dir]
+          path   = Dir.glob(File.join(dir, '**', "*.{#{OSDb.options[:movie_exts]}}"))
+          movies = path.map { |path| new(path) }
+        else
+          movies = ARGV.map{ |path| OSDb::Movie.new(path) }
+        end
+        movies.reject!(&:has_sub?) unless OSDb.options[:force]
+        
+        if movies.empty?
+          OSDb.log "All movies in #{dir} already have subtitles."
+          exit 1
+        end
+        
+        movies
+      end
+    end
+    
+    def initialize(path)
+      @path = path
+    end
+
+    def has_sub?
+      exist = false
+      %w(.srt .sub .smi).each{ |ext| exist ||= File.exist?(path.gsub(File.extname(path), ext)) }
+      exist
+    end
+
+    def sub_path(format)
+      path.gsub(File.extname(path), ".#{format}")
+    end
+    
+    def hash
+      @hash ||= self.class.compute_hash(path)
+    end
+    
+    def size
+      @size ||= File.size(path)
+    end
+    
+    CHUNK_SIZE = 64 * 1024 # in bytes
+    
+    # from http://trac.opensubtitles.org/projects/opensubtitles/wiki/HashSourceCodes
+    def self.compute_hash(path)
+      begin
+        filesize = File.size(path)
+        hash = filesize
+      
+        # Read 64 kbytes, divide up into 64 bits and add each
+        # to hash. Do for beginning and end of file.
+        File.open(path, 'rb') do |f|    
+          # Q = unsigned long long = 64 bit
+          f.read(CHUNK_SIZE).unpack("Q*").each do |n|
+            hash = hash + n & 0xffffffffffffffff # to remain as 64 bit number
+          end
+        
+          f.seek([0, filesize - CHUNK_SIZE].max, IO::SEEK_SET)
+        
+          # And again for the end of the file
+          f.read(CHUNK_SIZE).unpack("Q*").each do |n|
+            hash = hash + n & 0xffffffffffffffff
+          end
+        end
+      
+        sprintf("%016x", hash)
+      rescue Errno::EPERM
+        OSDb.log("* could not read #{path}")
+      rescue RuntimeError
+        OSDb.log("* could not read #{path}")
+      end
+    end
+    
+  end
+end

data/lib/osdb/options.rb

@@ -0,0 +1,51 @@
+module OSDb
+  class Options
+
+    class << self
+      def env_lang
+        OSDb::Language.from_locale(ENV['LANG'])
+      end
+
+      def parse_options
+        @@options = {:languages => [env_lang.to_iso639_2b], :force => false, :dir => nil, :silent => false, :movie_exts => %w{avi,mpg,m4v,mkv,mov,ogv,divx} }
+
+        @@parser ||= OptionParser.new do |opts|
+          opts.banner = "Automatically download subs for your video files using opensubtitles.org"
+          opts.separator ""
+          opts.separator "Usage: getsub [options] DIRECTORY | VIDEO_FILE [VIDEO_FILE ...]"
+          opts.separator ""
+          opts.separator "Main options:"
+
+          opts.on("-e", "--extensions EXTENSIONS", "Movie extensions to search for when using --directory. Default: #{@@options[:movie_exts].join(',')}") do |exts|
+            @@options[:movie_exts] = exts.split(',')
+          end
+          
+          opts.on("-l", "--languages LANGUAGES", "Sub language ISO 963 code separated by comma's like fre or eng. Default: env $LANG (#{env_lang.to_iso639_2b})") do |languages|
+            @@options[:languages] = languages.split(',')
+          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("-s", "--silent", "Don't output anything") { options[:silent] = true }
+        end
+        @@parser.parse!
+
+        if !@@options[:dir] && ARGV.empty?
+          help
+          exit 1
+        end
+
+        @@options
+      end
+
+      def help
+        puts @@parser.help
+      end
+    end
+
+  end
+end

data/lib/osdb/server.rb

@@ -0,0 +1,53 @@
+module OSDb
+  
+  class LoginFailed < ::Exception
+  end
+  
+  class Server
+    
+    attr_reader :username, :password, :language, :useragent, :client
+    
+    def initialize(options={})
+      @username = options[:username] || ''
+      @password = options[:password] || ''
+      @language = options[:language] || 'eng'
+      @useragent = options[:useragent] || 'ruby-osdb v0.1'
+      @client = ::XMLRPC::Client.new(*options.values_at(:host, :path, :port, :proxy_host, :proxy_port, :http_user, :http_password, :use_ssl, :timeout))
+    end
+    
+    def token
+      @token ||= login
+    end
+    
+    def login
+      response = client.call('LogIn', username, password, language, useragent)
+      if response['status'] != '200 OK'
+        raise LoginFailed.new("Failed to login with #{username} : #{password}. Server return code: #{response['status']}")
+      end
+      response['token']
+    end
+    
+    def logout
+      client.call('LogOut', token)
+      @token = nil
+    end
+    
+    def check_movie_hash(*hashes)
+      client.call('CheckMovieHash', token, hashes)
+    end
+    
+    def search_subtitles(*queries)
+      subs = client.call('SearchSubtitles', token, queries)['data']
+      subs ? subs.map{ |s| Sub.new(s) } : []
+    rescue EOFError
+      []
+    rescue RuntimeError
+      []
+    end
+    
+    def info
+      client.call('ServerInfo')
+    end
+    
+  end
+end

data/lib/osdb/sub.rb

@@ -0,0 +1,91 @@
+require 'uri'
+
+module OSDb
+  
+  class Sub
+    
+    attr_reader :url, :format, :language, :rating, :movie_name, :raw_data
+
+    class << self
+      def fetch_all
+        movies = Movie.get_movie_list
+        
+        movies.each do |movie|
+          begin
+            OSDb.log "* search subs for: #{movie.path}"
+            subs = OSDb.server.search_subtitles(:moviehash => movie.hash, :moviebytesize => movie.size, :sublanguageid => OSDb.options[:languages].join(','))
+            if subs.any?
+              if sub = select_sub(subs)
+                sub_path = movie.sub_path(sub.format)
+                Sub.download!(sub.url, sub_path)
+              end
+            else
+              OSDb.log "* no sub found"
+            end
+            OSDb.log
+          end
+        end
+      end
+
+      def download!(url, local_path)
+        OSDb.log "* download #{url} to #{local_path}"
+        if OSDb.curl_available?
+          %x{ curl -s '#{url}' | gunzip > "#{local_path}" }
+        elsif OSDb.wget_available?
+          %x{ wget -O -quiet - '#{url}' | gunzip > "#{local_path}"}
+        else
+          OSDb.log "Can't found any curl or wget please install one of them or manualy download your sub"
+          OSDb.log url
+        end
+      end
+
+      private
+        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
+          if selected_movie_subs = ask_user_to_identify_movie(movies)
+            selected_movie_subs.max
+          else
+            nil
+          end
+        end
+
+        def group_by_movie_name(subs)
+          subs.inject({}) do |hash, sub| 
+            hash[sub.movie_name] ||= []
+            hash[sub.movie_name] << sub
+            hash
+          end
+        end
+
+        def ask_user_to_identify_movie(movies)
+          puts "D'oh! You stumbled upon a hash conflict, please resolve it:"
+          puts
+          puts " 0 - none of the below"
+          movies.keys.each_with_index do |name, index|
+            puts " #{index+1} - #{name}"
+          end
+          puts
+          print 'id: '
+          str = STDIN.gets.to_i
+          str == 0 ? false : movies[movies.keys[str.to_i]]
+        end
+    end
+    
+    def initialize(data)
+      @url = URI.parse(data['SubDownloadLink'])
+      @format = data['SubFormat']
+      @language = Language.from_iso639_2b(data['SubLanguageID'])
+      @rating = data['SubRating'].to_f
+      @movie_name = data['MovieName']
+      @raw_data = data
+    end
+    
+    def <=>(other)
+      rating <=> other.rating
+    end
+    
+  end
+  
+end

data/osdb.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{osdb}
+  s.version = "0.0.5"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jean Boussier, Bart Zonneveld"]
+  s.date = %q{2010-12-09}
+  s.default_executable = %q{getsub}
+  s.description = %q{Ruby library to access OSDb services like OpenSubtitles.org}
+  s.email = %q{jean.boussier @nospam@ gmail.com, loop@superinfinite.com}
+  s.executables = ["getsub"]
+  s.extra_rdoc_files = ["README.md", "bin/getsub", "lib/osdb.rb", "lib/osdb/language.rb", "lib/osdb/movie.rb", "lib/osdb/server.rb", "lib/osdb/sub.rb", "lib/osdb/options.rb"]
+  s.files = FileList['lib/**/*.rb', 'bin/*', '[A-Z]*', 'spec/**/*'].to_a
+  s.homepage = %q{http://github.com/bartzon/ruby-osdb}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Osdb", "--main", "README.md"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{osdb}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Ruby library to access OSDb services like OpenSubtitles.org}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/spec/osdb/language_spec.rb

@@ -0,0 +1,57 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe OSDb::Language do
+  
+  describe '.from_locale' do
+    
+    describe "simple locale" do
+      
+      subject{ OSDb::Language.from_locale('fr') }
+      
+      its(:name) { should == 'French' }
+      
+      its(:to_iso639_1) { should == 'fr' }
+      
+      its(:to_iso639_2b) { should == 'fre' }
+      
+    end
+    
+    describe "locale with territory" do
+      
+      subject{ OSDb::Language.from_locale('en_US') }
+      
+      its(:name) { should == 'English (US)' }
+      
+      its(:to_iso639_1) { should == 'en' }
+      
+      its(:to_iso639_2b) { should == 'eng' }
+      
+    end
+
+    describe "locale with territory and encoding" do
+      
+      subject{ OSDb::Language.from_locale('es_ES.UTF8') }
+      
+      its(:name) { should == 'Spanish (Spain)' }
+      
+      its(:to_iso639_1) { should == 'es' }
+      
+      its(:to_iso639_2b) { should == 'spa' }
+      
+    end
+    
+  end
+  
+  describe ".from_iso_639_2b" do
+    
+    subject{ OSDb::Language.from_iso639_2b('bre') }
+    
+    its(:name) { should == 'English (UK)' }
+    
+    its(:to_iso639_1) { should == 'en' }
+    
+    its(:to_locale) { should == 'en_GB' }
+    
+  end
+  
+end

data/spec/osdb/movie_spec.rb

@@ -0,0 +1,11 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe OSDb::Movie do
+  
+  subject do
+    OSDb::Movie.new(File.dirname(__FILE__) + '/../fixtures/somemovie.avi')
+  end
+  
+  its(:hash) { should == '243339b48f4e8741' }
+  
+end

data/spec/osdb/server_spec.rb

@@ -0,0 +1,79 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe OSDb::Server do
+  
+  before :all do
+    @server = OSDb::Server.new(
+      :host => 'api.opensubtitles.org', 
+      :path => '/xml-rpc',
+      :timeout => 60, # OS.org is very very slow ....
+      :useragent => 'OS Test User Agent'
+    )
+  end
+  
+  subject { @server }
+  
+  it 'should respond to #info' do
+    hash_including(
+      "seconds" => instance_of(Float),
+      "last_update_strings" => instance_of(Hash),
+      "website_url"=>"http://www.opensubtitles.org",
+      "contact"=>"admin@opensubtitles.org",
+      "application"=>"OpenSuber v0.2",
+      "xmlrpc_version"=>"0.1",
+      "xmlrpc_url"=>"http://api.opensubtitles.net/xml-rpc"
+    ).should == subject.info
+  end
+  
+  it 'should automatically call #login when token is needed' do
+    subject.instance_variable_get('@token').should be_nil
+    subject.token.should match(/[a-z0-9]{26}/)
+    subject.instance_variable_get('@token').should == subject.token
+  end
+  
+  it 'should clear @login after #logout' do
+    expect{
+      subject.logout
+    }.to change{ subject.instance_variable_get('@token') }.from(instance_of(String)).to(nil)
+  end
+  
+  describe "#check_movie_hash" do
+    
+    it 'should identify movie' do
+      subject.check_movie_hash('37d0c7d0cfcbe280')['data'].should == {
+        "37d0c7d0cfcbe280" => {
+          "MovieYear" => "1996",
+          "MovieImdbID" => "0117500",
+          "MovieName" => "The Rock",
+          "MovieHash" => "37d0c7d0cfcbe280"
+        }
+      }
+    end
+    
+  end
+  
+  describe '#search_subtitles' do
+    
+    it 'can search by hash and size' do
+      subs = subject.search_subtitles(:moviehash => 'bd71526264fd8bd9', :moviebytesize => '183406990', :sublanguageid => 'fre')
+      subs.should be_a(Array)
+      subs.length.should >= 2
+      subs.each do |sub|
+        sub.language.name.should == 'French'
+        sub.raw_data['MovieName'].should == '"How I Met Your Mother"'
+      end
+    end
+    
+    it 'can search by imdbid' do
+      subs = subject.search_subtitles(:imdbid => "0117500", :sublanguageid => 'fre')
+      subs.should be_a(Array)
+      subs.length.should >= 1
+      subs.each do |sub|
+        sub.language.name.should == 'French'
+        sub.raw_data['MovieName'].should == 'The Rock'
+      end
+    end
+    
+  end
+  
+end

data/spec/osdb/sub_spec.rb

@@ -0,0 +1,33 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe OSDb::Sub do
+  
+  before :each do
+    @response = {
+      'SubFormat' => 'srt',
+      'SubDownloadLink' => 'http://example.com/foo.srt.gz',
+      'SubRating' => '7.89',
+      'SubLanguageID' => 'dut',
+      'MovieName' => 'Lock, Stock and Two Smoking Barrels'
+    }
+  end
+  
+  subject do
+    OSDb::Sub.new @response
+  end
+  
+  its(:format) { should == 'srt' }
+  
+  its(:url) { should be_an(URI::HTTP) }
+  
+  its(:language) { should be_a(OSDb::Language) }
+  
+  its(:rating) { should == 7.89 }
+  
+  its(:movie_name) { should == 'Lock, Stock and Two Smoking Barrels' }
+  
+  it 'should be comparable' do
+    [subject, OSDb::Sub.new(@response.merge('SubRating' => '2.45'))].max.should == subject
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require File.dirname(__FILE__) + '/../lib/osdb'
+require 'spec/autorun'
+
+# Spec Helpers
+Dir[File.dirname(__FILE__) + '/*_spec_helper.rb'].each do |f|
+  require File.expand_path(f)
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification 
+name: bartzon-osdb
+version: !ruby/object:Gem::Version 
+  hash: 19
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 6
+  version: 0.0.6
+platform: ruby
+authors: 
+- Jean Boussier, Bart Zonneveld
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-09 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: Ruby library to access OSDb services like OpenSubtitles.org
+email: jean.boussier @nospam@ gmail.com, loop@superinfinite.com
+executables: 
+- getsub
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+- bin/getsub
+- lib/osdb.rb
+- lib/osdb/language.rb
+- lib/osdb/movie.rb
+- lib/osdb/options.rb
+- lib/osdb/server.rb
+- lib/osdb/sub.rb
+files: 
+- Manifest
+- README.md
+- Rakefile
+- bin/getsub
+- lib/osdb.rb
+- lib/osdb/language.rb
+- lib/osdb/movie.rb
+- lib/osdb/options.rb
+- lib/osdb/server.rb
+- lib/osdb/sub.rb
+- osdb.gemspec
+- spec/fixtures/somemovie.avi
+- spec/osdb/language_spec.rb
+- spec/osdb/movie_spec.rb
+- spec/osdb/server_spec.rb
+- spec/osdb/sub_spec.rb
+- spec/spec_helper.rb
+- bartzon-osdb.gemspec
+has_rdoc: true
+homepage: http://github.com/bartzon/ruby-osdb
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Bartzon-osdb
+- --main
+- README.md
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 11
+      segments: 
+      - 1
+      - 2
+      version: "1.2"
+requirements: []
+
+rubyforge_project: bartzon-osdb
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Ruby library to access OSDb services like OpenSubtitles.org
+test_files: []
+