pirate-autosub 0.2.1

data/README.markdown

@@ -0,0 +1,57 @@
+# AutoSub
+  
+Ruby tool to automatically download subtitles (srt) inside your TV Shows folder.
+Currently only english and french subtitles are supported.
+  
+## Install
+
+    sudo gem install pirate-autosub --source http://gems.github.com
+
+## Usage
+
+In your terminal:
+
+    autosub -p /path/of/your/TV Shows/folder -lang fr,en
+
+more details with:
+
+    autosub -h
+    
+## Folder Name Convention
+
+AutoNZB use (and needs) specific folders/episodes name for your TV Shows:
+  
+    + TV Shows
+      + Dexter (TV Show's name needs to be 'clean')
+        + Season 01
+          - Dexter S01E01.mkv (.mkv for 720p HD episode)
+          - Dexter 1x02.avi (.avi for SD episode)
+          - S01E03.mkv (TV Show's name in episode file's name not needed)
+          - S01E03.fr.srt (.fr.srt used to define subtitle's language)
+    + Fringe
+      - (season folder not needed)
+      - Fringe S01E01.mkv
+      - 1x01.avi
+  
+## License
+
+Copyright (c) 2008 Pirate
+ 
+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/Rakefile

@@ -0,0 +1,16 @@
+# Rakefile
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('autosub', '0.2.1') do |p|
+  p.description    = "Ruby tool to automatically download subtitles (srt) inside your TV Shows folder"
+  p.url            = "http://github.com/pirate/autosub"
+  p.author         = "Pirate"
+  p.email          = "pirate.2061@gmail.com"
+  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.executable_pattern = "bin/autosub"
+  p.runtime_dependencies = ["hpricot", "rubyzip", "optiflag", "simple-rss"]
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/autosub.gemspec

@@ -0,0 +1,48 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{autosub}
+  s.version = "0.2.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Pirate"]
+  s.date = %q{2008-12-28}
+  s.default_executable = %q{autosub}
+  s.description = %q{Ruby tool to automatically download subtitles (srt) inside your TV Shows folder}
+  s.email = %q{pirate.2061@gmail.com}
+  s.executables = ["autosub"]
+  s.extra_rdoc_files = ["bin/autosub", "lib/episode.rb", "lib/inspector.rb", "lib/sites/seriessub.rb", "lib/sites/tvsubtitle.rb", "README.markdown"]
+  s.files = ["asset/srt.png", "autosub.gemspec", "bin/autosub", "lib/episode.rb", "lib/inspector.rb", "lib/sites/seriessub.rb", "lib/sites/tvsubtitle.rb", "Manifest", "Rakefile", "README.markdown"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/pirate/autosub}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Autosub", "--main", "README.markdown"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{autosub}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Ruby tool to automatically download subtitles (srt) inside your TV Shows folder}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<hpricot>, [">= 0"])
+      s.add_runtime_dependency(%q<rubyzip>, [">= 0"])
+      s.add_runtime_dependency(%q<optiflag>, [">= 0"])
+      s.add_runtime_dependency(%q<simple-rss>, [">= 0"])
+      s.add_development_dependency(%q<echoe>, [">= 0"])
+    else
+      s.add_dependency(%q<hpricot>, [">= 0"])
+      s.add_dependency(%q<rubyzip>, [">= 0"])
+      s.add_dependency(%q<optiflag>, [">= 0"])
+      s.add_dependency(%q<simple-rss>, [">= 0"])
+      s.add_dependency(%q<echoe>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<hpricot>, [">= 0"])
+    s.add_dependency(%q<rubyzip>, [">= 0"])
+    s.add_dependency(%q<optiflag>, [">= 0"])
+    s.add_dependency(%q<simple-rss>, [">= 0"])
+    s.add_dependency(%q<echoe>, [">= 0"])
+  end
+end

data/bin/autosub

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+require 'optiflag'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'inspector')
+
+module AutoSub extend OptiFlagSet
+  flag "p" do
+    description "Directory path with many TV Shows directories"
+  end
+  optional_flag "lang" do
+    description "Language(s) you want for your subtitles, default: fr,en
+                  (Order is important to define if a srt is needed)"
+  end
+
+  and_process!
+end
+
+begin
+  inspector = Inspector.new(ARGV.flags.p, ARGV.flags.lang)
+rescue => e
+  p e.to_s
+  Inspector.growl("AutoSub Error!", 'look into the console log', 'failure.png')
+end

data/lib/episode.rb

@@ -0,0 +1,89 @@
+class Episode
+  
+  attr_accessor :path, :name, :ext, :format, :srt, :tv_show, :season, :number
+  
+  def initialize(tv_show, path)
+    @path = path
+    @ext  = File.extname(@path)
+    @name = File.basename(path, @ext)
+    @tv_show = tv_show
+    @srt = []
+    
+    search_existing_srt
+    define_format
+    define_season_and_episode_number
+  end
+  
+  def filename
+    @name + @ext
+  end
+  
+  def episode_name
+    "#{@tv_show} S#{@season < 10 ? "0#{@season}" : @season}E#{@number < 10 ? "0#{@number}" : @number}"
+  end
+  
+  def episode_name_with_format    
+    episode_name + "#{format == 'hd' ? ' 720p' : ''}"
+  end
+  
+  def need_srt?(langs)
+    need = -1
+    langs = langs.reverse
+    langs.each do |lang|
+      need = langs.index(lang) if @srt.include?(lang) && need < langs.index(lang)
+    end
+    need != langs.size - 1
+  end
+  
+  def srt_filename(lang)
+    "#{File.dirname(path)}/#{name}.#{lang}.srt"
+  end
+  
+  def self.valid?(filename)
+    filename.match(/.*(([0-9]{1,2}X[0-9]{1,2})|(S[0-9][0-9]E[0-9][0-9])).*((\.avi)|(\.mkv))$/i)
+  end
+  
+  def good_format?(filename)
+    case @format
+    when 'hd'
+      filename.include?('720p')
+    when 'sd'
+      !filename.include?('720p')
+    end
+  end
+  
+private
+  
+  def search_existing_srt
+    dir = Dir.new(File.dirname(@path))
+    dir.select { |el| File.extname(el) == '.srt' && el.include?(@name) && !el.include?('._') }.each do |srt|
+      case srt
+      when /\.(french|fr|fre|fra)\.srt/i
+        @srt << 'fr'
+      when /\.(english|en|eng)\.srt/i
+        @srt << 'en'
+      end
+    end
+  end
+  
+  def define_format
+    case @ext
+    when '.mkv'
+      @format = 'hd'
+    when '.avi'
+      @format = 'sd'
+    end
+  end
+  
+  def define_season_and_episode_number
+    case @name
+    when /S[0-9][0-9]E[0-9][0-9]/i # S02E03
+      @season = @name.match(/.*S([0-9]{1,2})E.*$/i)[1].to_i
+      @number = @name.match(/.*E([0-9]{1,2}).*$/i)[1].to_i
+    when /[0-9]{1,2}X[0-9]{1,2}/i  # 2X03
+      @season = @name.match(/.*([0-9]{1,2})X[0-9]{1,2}.*$/i)[1].to_i
+      @number = @name.match(/.*[0-9]{1,2}X([0-9]{1,2}).*$/i)[1].to_i
+    end
+  end
+  
+end

data/lib/inspector.rb

@@ -0,0 +1,76 @@
+require File.join(File.dirname(__FILE__), '..', 'lib', 'episode')
+require File.join(File.dirname(__FILE__), '..', 'lib', 'sites', 'seriessub')
+require File.join(File.dirname(__FILE__), '..', 'lib', 'sites', 'tvsubtitle')
+
+class Inspector
+  
+  attr_accessor :tv_shows, :episodes, :langs
+  
+  def initialize(path , langs = nil)
+    @path = path.gsub(/\/$/,'')
+    @langs = langs ? langs.split(',') : ['fr','en']
+
+    @tv_shows = [] # {:name => ..., :path => ...}
+    initialize_tv_shows
+    $stdout.print "Found #{@tv_shows.size} TV Show(s) in #{@path}\n"
+    
+    @episodes = []
+    initialize_episodes
+    # keep only episodes who needs srt
+    $stdout.print "Found #{@episodes.select { |e| e.need_srt?(@langs) }.size} episode(s) who need(s) srt\n"
+    
+    # Find new srt
+    TVSubtitle.new(self)
+    SeriesSub.new(self)
+  end
+  
+  def growl_episode(episode, lang)
+    Inspector.growl episode.episode_name_with_format, "#{lang_name(lang)} srt added", "srt.png"
+  end
+  
+  def self.growl(title, msg, icon, pri = 0)
+    system("/usr/local/bin/growlnotify -w -n autosub --image #{File.dirname(__FILE__) + "/../asset/#{icon}"} -p #{pri} -m #{msg.inspect} #{title} &") 
+  end
+  
+private
+  
+  def initialize_tv_shows
+    # path is a dir with many tv_shows dir
+    base_dir = clean_dir(Dir.new(@path))
+    base_dir.each do |tv_show_name|
+      @tv_shows << { :name => tv_show_name, :path => "#{@path}/#{tv_show_name}" }
+    end
+  end
+  
+  def initialize_episodes
+    @tv_shows.each do |tv_show|
+      search_episodes(tv_show[:name], tv_show[:path])
+    end
+  end
+  
+  def search_episodes(tv_show_name, path)
+    elements = clean_dir(Dir.new(path))
+    elements.each do |el|
+      el_path = "#{path}/#{el}"
+      if File.directory?(el_path)
+        search_episodes(tv_show_name, el_path)
+      elsif Episode.valid?(el)
+        episodes << Episode.new(tv_show_name, el_path)
+      end
+    end
+  end
+  
+  def clean_dir(dir)
+    dir.select { |e| !["..", ".", ".DS_Store", ".com.apple.timemachine.supported"].include?(e) }
+  end
+
+  def lang_name(lang)
+    case lang
+    when 'en'
+      'English'
+    when 'fr'
+      'French'
+    end
+  end
+  
+end

data/lib/sites/seriessub.rb

@@ -0,0 +1,116 @@
+require 'hpricot'
+require 'open-uri'
+require 'zip/zip'
+
+# http://www.seriessub.com/
+class SeriesSub
+  
+  def initialize(inspector)
+    @inspector = inspector
+    episodes = @inspector.episodes.select { |e| e.need_srt?(@inspector.langs) }
+
+    $stdout.print "------------------------------------------\n"
+    $stdout.print "Start srt searching from www.seriessub.com\n"
+    $stdout.print "------------------------------------------\n"
+    episodes.each do |e|
+      @inspector.langs.each do |l|
+        unless e.srt.include?(l) 
+          $stdout.print "#{e.episode_name_with_format} [#{l}]: "
+          if get_srt(e, l)
+            $stdout.print "FOUND\n"
+            e.srt << l
+            @inspector.growl_episode(e, l)
+            break
+          else
+            $stdout.print "NOT FOUND\n"
+          end
+        end
+      end
+    end
+  end
+    
+private
+  
+  def get_srt(episode, lang)
+    found = false
+    doc = Hpricot(open(url(episode)))
+    doc.search("td.gst_fichier a").each do |el|
+      text = el.inner_text.gsub(/(\_|\.)/, ' ')
+      if good_episode?(episode, text) && text.include?(lang_version(lang))
+        if text.include?('zip')
+          Tempfile.open("tv.zip") do |tempfile|
+            tempfile.write(open(el[:href]).read) # download the zip
+            tempfile.close # tempfile need to be closed for unzip it
+            Zip::ZipFile.open(tempfile.path) do |zip_file|
+              zip_file.each do |f|
+                if good_episode?(episode, f.name) && f.name.include?(lang_version(lang)) && episode.good_format?(f.name) && no_tag?(f.name)
+                  zip_file.extract(f, episode.srt_filename(lang))
+                  found = true
+                end
+              end
+            end
+          end
+        elsif episode.good_format?(text) && no_tag?(text) # just a single srt file
+          Tempfile.open("tv.srt") do |tempfile|
+            tempfile.write(open(el[:href]).read) # download the zip
+            tempfile.close
+            File.move(tempfile.path, episode.srt_filename(lang))
+            found = true
+          end
+        end
+      end
+    end
+    found
+  end
+
+  
+  def url(episode)
+    "http://www.seriessub.com/sous-titres/#{tv_show(episode)}/#{season(episode)}"
+  end
+  
+  def tv_show(episode)
+    name = episode.tv_show.gsub(/\s\([0-9]{4}\)/,'')
+    case name
+    when "Terminator The Sarah Connor Chronicles"
+      "The Sarah Connor Chronicles"
+    when "The IT Crowd"
+      "IT Crowd"
+    else
+      name
+    end.downcase.gsub(/\s/, '_')
+  end
+  
+  def season(episode)
+    "saison_#{episode.season}"
+  end
+  
+  def lang_version(lang)
+    case lang
+    when 'fr'
+      "VF"
+    when 'en'
+      "VO"
+    end
+  end
+  
+  def num(episode)
+    "#{episode.season}#{episode.number < 10 ? "0#{episode.number}" : episode.number}"
+  end
+  
+  def good_episode?(episode, name)
+    num2 = "S#{episode.season < 10 ? "0#{episode.season}" : episode.season}E#{episode.number < 10 ? "0#{episode.number}" : episode.number}"
+    name.include?(num(episode)) || name.include?(num2)
+  end
+  
+  def no_tag?(filename)
+    case filename
+    when /notag/i
+      true
+    when /tag/i
+      false
+    else
+      true
+    end
+  end
+  
+end

data/lib/sites/tvsubtitle.rb

@@ -0,0 +1,70 @@
+require 'simple-rss'
+require 'open-uri'
+require 'zip/zip'
+require 'cgi'
+
+# http://www.tvsubtitles.net/
+class TVSubtitle
+  
+  def initialize(inspector)
+    @inspector = inspector
+    episodes = @inspector.episodes.select { |e| e.need_srt?(@inspector.langs) }
+    
+    $stdout.print "--------------------------------------------\n"
+    $stdout.print "Searching fot srt in www.tvsubtitles.net RSS\n"
+    $stdout.print "--------------------------------------------\n"
+    @inspector.langs.each do |l|
+      rss(l).items.each do |item|
+        episodes.each do |e|
+          unless e.srt.include?(l) 
+            if episode_title(e, l) == item_title(item)
+              $stdout.print "FOUND: #{e.episode_name_with_format} [#{l}]\n"
+              download_srt(item, e, l)
+              e.srt << l
+              @inspector.growl_episode(e, l)
+            end
+          end
+        end
+      end
+    end
+  end
+  
+private
+
+  def srt_link(item)
+    id = item.link.match(/([0-9]+)/)[1]
+    http = Net::HTTP.new('www.tvsubtitles.net')
+    resp, data = http.get("/download-#{id}.html")
+    "http://www.tvsubtitles.net/#{resp.response['Location'].gsub(/\s/, '%20')}"
+  end
+
+  def download_srt(item, episode, lang)
+    url = srt_link(item)
+    Tempfile.open("srt") do |tempfile|
+      tempfile.write(open(url).read) # download the srt
+      tempfile.close
+      Zip::ZipFile.open(tempfile.path) do |zip_file|
+        zip_file.each do |f|
+          zip_file.extract(f, episode.srt_filename(lang))
+        end
+      end
+    end
+  end
+  
+  def rss(lang)
+    SimpleRSS.parse open("http://fr.tvsubtitles.net/rss#{lang}.xml") 
+  end
+  
+  def num(episode)
+    "#{episode.season}X#{episode.number < 10 ? "0#{episode.number}" : episode.number}"
+  end
+  
+  def episode_title(episode, lang)
+    "#{episode.tv_show} #{num(episode)} #{lang} #{episode.format}".downcase
+  end
+
+  def item_title(item)
+    "#{item.title} #{item.description.include?('720p') ? 'hd' : 'sd'}".downcase
+  end
+  
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification 
+name: pirate-autosub
+version: !ruby/object:Gem::Version 
+  version: 0.2.1
+platform: ruby
+authors: 
+- Pirate
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-28 00:00:00 -08:00
+default_executable: autosub
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hpricot
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rubyzip
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: optiflag
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: simple-rss
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: echoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Ruby tool to automatically download subtitles (srt) inside your TV Shows folder
+email: pirate.2061@gmail.com
+executables: 
+- autosub
+extensions: []
+
+extra_rdoc_files: 
+- bin/autosub
+- lib/episode.rb
+- lib/inspector.rb
+- lib/sites/seriessub.rb
+- lib/sites/tvsubtitle.rb
+- README.markdown
+files: 
+- asset/srt.png
+- autosub.gemspec
+- bin/autosub
+- lib/episode.rb
+- lib/inspector.rb
+- lib/sites/seriessub.rb
+- lib/sites/tvsubtitle.rb
+- Manifest
+- Rakefile
+- README.markdown
+has_rdoc: true
+homepage: http://github.com/pirate/autosub
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Autosub
+- --main
+- README.markdown
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: autosub
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Ruby tool to automatically download subtitles (srt) inside your TV Shows folder
+test_files: []
+