osdb 0.0.10 → 0.1.0

data/lib/osdb/movie_file.rb

@@ -0,0 +1,61 @@
+module OSDb
+  class MovieFile
+
+    EXTENSIONS = %w(avi mpg m4v mkv mov ogv mp4)
+
+    attr_reader :path
+
+    def initialize(path)
+      @path = path
+    end
+
+    def has_sub?
+      exist = false
+      %w(.srt .sub).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
+
+    def name
+      @name ||= File.basename(path, File.extname(path))
+    end
+    
+    CHUNK_SIZE = 64 * 1024 # in bytes
+    
+    # from http://trac.opensubtitles.org/projects/opensubtitles/wiki/HashSourceCodes
+    def self.compute_hash(path)
+      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)
+    end
+
+  end
+end

data/lib/osdb/search.rb

@@ -0,0 +1,9 @@
+module OSDb
+  module Search
+    base_path = File.expand_path(File.dirname(__FILE__) + '/search')
+    autoload :IMDB,       "#{base_path}/imdb"
+    autoload :MovieHash,  "#{base_path}/movie_hash"
+    autoload :Name,       "#{base_path}/name"
+    autoload :Path,       "#{base_path}/path"
+  end
+end

data/lib/osdb/search/imdb.rb

@@ -0,0 +1,24 @@
+module OSDb
+  module Search
+
+    class IMDB
+
+      def initialize(server, selector=Finder::First.new)
+        @server = server
+        @selector = selector
+      end
+
+      def search_subs_for(movie, language)
+        imdb_results = @server.search_imdb(:query => movie.name)
+        if imdb_result = @selector.chose(imdb_results)
+          @server.search_subtitles(
+            :sublanguageid => language,
+            :imdbid => imdb_result.imdbid
+          )
+        end
+      end
+
+    end
+
+  end
+end

data/lib/osdb/search/movie_hash.rb

@@ -0,0 +1,21 @@
+module OSDb
+  module Search
+
+    class MovieHash
+
+      def initialize(server)
+        @server = server
+      end
+
+      def search_subs_for(movie, language)
+        @server.search_subtitles(
+          :moviehash => movie.hash,
+          :moviebytesize => movie.size.to_s,
+          :sublanguageid => language
+        )
+      end
+
+    end
+
+  end
+end

data/lib/osdb/search/name.rb

@@ -0,0 +1,28 @@
+module OSDb
+  module Search
+
+    class Name
+
+      def initialize(server)
+        @server = server
+      end
+
+      def search_subs_for(movie, language)
+        subs = @server.search_subtitles(:sublanguageid => 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
+      end
+
+      protected
+
+      def normalize_name(name)
+        name.downcase.gsub(/[\s\.\-\_]+/, ' ')
+      end
+
+    end
+
+  end
+end

data/lib/osdb/search/path.rb

@@ -0,0 +1,20 @@
+module OSDb
+  module Search
+
+    class Path
+
+      def initialize(server)
+        @server = server
+      end
+
+      def search_subs_for(movie, language)
+        @server.search_subtitles(
+          :sublanguageid => language,
+          :tag => movie.path
+        )
+      end
+
+    end
+
+  end
+end

data/lib/osdb/selector.rb

@@ -0,0 +1,7 @@
+module OSDb
+  module Selector
+    base_path = File.expand_path(File.dirname(__FILE__) + '/selector')
+    autoload :Format, "#{base_path}/format"
+    autoload :Movie,  "#{base_path}/movie"
+  end
+end

data/lib/osdb/selector/format.rb

@@ -0,0 +1,17 @@
+module OSDb
+  module Selector
+
+    class Format
+
+      def initialize(formats)
+        @formats = formats
+      end
+
+      def select(subs, movie)
+        subs.select{ |s| @formats.include?(s.format) }
+      end
+
+    end
+
+  end
+end

data/lib/osdb/selector/movie.rb

@@ -0,0 +1,31 @@
+module OSDb
+  module Selector
+
+    class Movie
+
+      def initialize(movie_finder=Finder::First.new)
+        @movie_finder = movie_finder
+      end
+
+      def select(subs, movie)
+        subs_by_movie = group_by_movie_name(subs)
+
+        return subs if subs_by_movie.length <= 1
+
+        movie_names = subs_by_movie.keys
+        movie_name = @movie_finder.chose(movie_names)
+        subs_by_movie[movie_name] || []
+      end
+
+      def group_by_movie_name(subs)
+        subs.inject({}) do |hash, sub| 
+          hash[sub.movie_name] ||= []
+          hash[sub.movie_name] << sub
+          hash
+        end
+      end
+
+    end
+
+  end
+end

data/lib/osdb/server.rb

@@ -53,5 +53,9 @@ module OSDb
       client.call('ServerInfo')
     end
 
+    def get_imdb_movie_details(id)
+      Movie.new(client.call('GetIMDBMovieDetails', token, id)['data'])
+    end
+
   end
 end

data/lib/osdb/subtitle_finder.rb

@@ -0,0 +1,31 @@
+module OSDb
+
+  class SubtitleFinder
+
+    def initialize(search_engines, finders, selectors=[])
+      @search_engines = search_engines
+      @finders = finders
+      @selectors = selectors
+    end
+
+    def find_sub_for(movie, language)
+      @search_engines.each do |engine|
+        subs = engine.search_subs_for(movie, language)
+
+        subs = @selectors.inject(subs) do |subs, selector|
+          selector.select(subs, movie)
+        end
+
+        @finders.each do |finder|
+          sub = finder.chose(subs)
+          return sub if sub
+        end
+
+      end
+
+      nil
+    end
+
+  end
+
+end

data/lib/osdb/version.rb

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

data/osdb.gemspec

@@ -19,4 +19,6 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'
+  s.add_development_dependency 'webmock', '~> 1.8.11'
+  s.add_development_dependency 'vcr', '~> 2.3.0'
 end

data/spec/fixtures/http/check_movie_hash.yml

@@ -0,0 +1,225 @@
+--- 
+http_interactions: 
+- request: 
+    method: post
+    uri: http://api.opensubtitles.org/xml-rpc
+    body: 
+      string: |
+        <?xml version="1.0" ?><methodCall><methodName>LogIn</methodName><params><param><value><string></string></value></param><param><value><string></string></value></param><param><value><string>eng</string></value></param><param><value><string>OS Test User Agent</string></value></param></params></methodCall>
+
+    headers: 
+      Accept: 
+      - "*/*"
+      Cookie: 
+      - PHPSESSID=qtqkphpa0us78eikqtdtg4jic7
+      Content-Length: 
+      - "304"
+      User-Agent: 
+      - XMLRPC::Client (Ruby 1.8.7)
+      Content-Type: 
+      - text/xml; charset=utf-8
+      Connection: 
+      - keep-alive
+  response: 
+    status: 
+      code: 200
+      message: OK
+    headers: 
+      X-Cache: 
+      - MISS
+      Age: 
+      - "0"
+      X-Cache-Backend: 
+      - www
+      Cache-Control: 
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      Pragma: 
+      - no-cache
+      Expires: 
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      Content-Length: 
+      - "504"
+      Content-Type: 
+      - text/xml
+      Connection: 
+      - keep-alive
+      Accept-Ranges: 
+      - bytes
+      Date: 
+      - Sun, 04 Nov 2012 17:11:36 GMT
+    body: 
+      string: |
+        <?xml version="1.0" encoding="utf-8"?>
+        <methodResponse>
+        <params>
+         <param>
+          <value>
+           <struct>
+            <member>
+             <name>token</name>
+             <value>
+              <string>qtqkphpa0us78eikqtdtg4jic7</string>
+             </value>
+            </member>
+            <member>
+             <name>status</name>
+             <value>
+              <string>200 OK</string>
+             </value>
+            </member>
+            <member>
+             <name>seconds</name>
+             <value>
+              <double>0.009</double>
+             </value>
+            </member>
+           </struct>
+          </value>
+         </param>
+        </params>
+        </methodResponse>
+
+    http_version: 
+  recorded_at: Sun, 04 Nov 2012 17:11:36 GMT
+- request: 
+    method: post
+    uri: http://api.opensubtitles.org/xml-rpc
+    body: 
+      string: |
+        <?xml version="1.0" ?><methodCall><methodName>CheckMovieHash</methodName><params><param><value><string>qtqkphpa0us78eikqtdtg4jic7</string></value></param><param><value><array><data><value><string>37d0c7d0cfcbe280</string></value></data></array></value></param></params></methodCall>
+
+    headers: 
+      Accept: 
+      - "*/*"
+      Cookie: 
+      - PHPSESSID=qtqkphpa0us78eikqtdtg4jic7
+      Content-Length: 
+      - "283"
+      User-Agent: 
+      - XMLRPC::Client (Ruby 1.8.7)
+      Content-Type: 
+      - text/xml; charset=utf-8
+      Connection: 
+      - keep-alive
+  response: 
+    status: 
+      code: 200
+      message: OK
+    headers: 
+      X-Cache: 
+      - MISS
+      Age: 
+      - "0"
+      X-Cache-Backend: 
+      - www
+      Cache-Control: 
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      Set-Cookie: 
+      - PHPSESSID=qtqkphpa0us78eikqtdtg4jic7; path=/
+      Pragma: 
+      - no-cache
+      Expires: 
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      Content-Length: 
+      - "1800"
+      Content-Type: 
+      - text/xml
+      Connection: 
+      - keep-alive
+      Accept-Ranges: 
+      - bytes
+      Date: 
+      - Sun, 04 Nov 2012 17:11:36 GMT
+    body: 
+      string: |
+        <?xml version="1.0" encoding="utf-8"?>
+        <methodResponse>
+        <params>
+         <param>
+          <value>
+           <struct>
+            <member>
+             <name>status</name>
+             <value>
+              <string>200 OK</string>
+             </value>
+            </member>
+            <member>
+             <name>data</name>
+             <value>
+              <struct>
+               <member>
+                <name>37d0c7d0cfcbe280</name>
+                <value>
+                 <struct>
+                  <member>
+                   <name>MovieHash</name>
+                   <value>
+                    <string>37d0c7d0cfcbe280</string>
+                   </value>
+                  </member>
+                  <member>
+                   <name>MovieImdbID</name>
+                   <value>
+                    <string>0117500</string>
+                   </value>
+                  </member>
+                  <member>
+                   <name>MovieName</name>
+                   <value>
+                    <string>The Rock</string>
+                   </value>
+                  </member>
+                  <member>
+                   <name>MovieYear</name>
+                   <value>
+                    <string>1996</string>
+                   </value>
+                  </member>
+                  <member>
+                   <name>MovieKind</name>
+                   <value>
+                    <string>movie</string>
+                   </value>
+                  </member>
+                  <member>
+                   <name>SeriesSeason</name>
+                   <value>
+                    <string>0</string>
+                   </value>
+                  </member>
+                  <member>
+                   <name>SeriesEpisode</name>
+                   <value>
+                    <string>0</string>
+                   </value>
+                  </member>
+                 </struct>
+                </value>
+               </member>
+              </struct>
+             </value>
+            </member>
+            <member>
+             <name>not_processed</name>
+             <value>
+              <array>
+               <data/>
+              </array>
+             </value>
+            </member>
+            <member>
+             <name>seconds</name>
+             <value>
+              <double>0.016</double>
+             </value>
+            </member>
+           </struct>
+          </value>
+         </param>
+        </params>
+        </methodResponse>
+
+    http_version: 
+  recorded_at: Sun, 04 Nov 2012 17:11:36 GMT
+recorded_with: VCR 2.3.0