addic7ed 0.1.0

data/lib/addic7ed/episode.rb

@@ -0,0 +1,106 @@
+require 'nokogiri'
+require 'net/http'
+require 'open-uri'
+
+module Addic7ed
+  class Episode
+
+    attr_reader :filename
+
+    def initialize(filename)
+      @filename = Addic7ed::Filename.new(filename)
+    end
+
+    def url(lang = 'fr')
+      raise LanguageNotSupported unless LANGUAGES[lang]
+      @localized_urls ||= {}
+      @localized_urls[lang] ||= "http://www.addic7ed.com/serie/#{@filename.showname.gsub(' ', '_')}/#{@filename.season}/#{@filename.episode}/#{LANGUAGES[lang][:id]}"
+    end
+
+    def subtitles(lang = 'fr')
+      raise LanguageNotSupported unless LANGUAGES[lang]
+      unless @subtitles and @subtitles[lang]
+        @subtitles ||= {}
+        @subtitles[lang] ||= []
+        response = Net::HTTP.get_response(URI(url(lang)))
+        raise EpisodeNotFound if response.body == " "
+        doc = Nokogiri::HTML(response.body)
+        raise NoSubtitleFound unless doc.css('select#filterlang ~ font[color="yellow"]').empty?
+        sublist_node = doc.css('#container95m table.tabel95 table.tabel95')
+        raise NoSubtitleFound if sublist_node.size == 0
+        sublist_node.each do |sub_node|
+          @subtitles[lang] << parse_subtitle_node(sub_node, lang)
+        end
+      end
+      @subtitles[lang]
+    end
+
+    def best_subtitle(lang = 'fr')
+      raise LanguageNotSupported unless LANGUAGES[lang]
+      unless @best_subtitle and @best_subtitle[lang]
+        @best_subtitle ||= {}
+        subtitles(lang).each do |sub|
+          if sub.status == 'Completed' and (sub.version == @filename.group or COMPATIBILITY_720P[sub.version] == @filename.group)
+            @best_subtitle[lang] = sub unless @best_subtitle[lang] and @best_subtitle[lang].downloads > sub.downloads
+          end
+        end
+        raise NoSubtitleFound unless @best_subtitle[lang]
+      end
+      return @best_subtitle[lang]
+    end
+
+    def download_best_subtitle!(lang = 'fr', redirect_limit = 8)
+      raise WTFError.new('Too many HTTP redirects') if redirect_limit == 0
+      begin
+        uri = URI(best_subtitle(lang).url)
+        response = Net::HTTP.start(uri.hostname, uri.port) do |http|
+          request = Net::HTTP::Get.new(uri.request_uri)
+          # Addic7ed needs the Referer to be correct. User-agent is just here to fake a real browser request, because we never know...
+          request['Referer'] = url(lang)
+          request['User-Agent'] = USER_AGENTS.sample
+          http.request(request)
+        end
+      rescue Errno::ECONNREFUSED
+        raise DownloadLimitReached
+      rescue
+        raise DownloadError
+      end
+      if response.kind_of?(Net::HTTPRedirection)
+        # Addic7ed is serving redirection URL not-encoded.
+        # Ruby does not support it yet (see http://bugs.ruby-lang.org/issues/7396)
+         best_subtitle(lang).url = URI.escape(response['location'])
+         download_best_subtitle!(lang, redirect_limit - 1)
+      else
+        begin
+          open "#{filename}".gsub(/\.\w{3}$/, '.srt'), 'w' do |f|
+            f << response.body
+          end
+        rescue
+          raise SubtitleCannotBeSaved
+        end
+      end
+    end
+
+    protected
+
+    def parse_subtitle_node(sub_node, lang)
+      begin
+        version_node = sub_node.css('.NewsTitle').first
+        version = version_node.content.gsub(/ \nVersion /, '').gsub(/,.*/, '')
+        language_node = sub_node.css('.language').first
+        language = language_node.content.gsub(/\A\W*/, '').gsub(/[^\w\)]*\z/, '')
+        raise WTFError.new("We're asking for #{LANGUAGES[lang][:name].capitalize} subtitles and Addic7ed gives us #{language.capitalize} subtitles") if LANGUAGES[lang][:name].downcase != language.downcase
+        status_node = sub_node.css('tr:nth-child(3) td:nth-child(4) b').first
+        status = status_node.content.strip
+        url_node = sub_node.css('a.buttonDownload').first
+        url = 'http://www.addic7ed.com' + url_node['href']
+        downloads_node = sub_node.css('tr:nth-child(4) td.newsDate').first
+        downloads = /(?<downloads>\d*) Downloads/.match(downloads_node.content)[:downloads]
+        Addic7ed::Subtitle.new(version, language, status, url, downloads)
+      rescue
+        raise ParsingError
+      end
+    end
+
+  end
+end

data/lib/addic7ed/errors.rb

@@ -0,0 +1,22 @@
+module Addic7ed
+  class InvalidFilename < StandardError
+  end
+  class ShowNotFound < StandardError
+  end
+  class EpisodeNotFound < StandardError
+  end
+  class LanguageNotSupported < StandardError
+  end
+  class ParsingError < StandardError
+  end
+  class NoSubtitleFound < StandardError
+  end
+  class DownloadError < StandardError
+  end
+  class DownloadLimitReached < StandardError
+  end
+  class SubtitleCannotBeSaved < StandardError
+  end
+  class WTFError < StandardError
+  end
+end

data/lib/addic7ed/filename.rb

@@ -0,0 +1,50 @@
+module Addic7ed
+  class Filename
+
+    TVSHOW_REGEX = /\A(?<showname>.*\w)[\[\. ]+S?(?<season>\d{1,2})[-\. ]?[EX]?(?<episode>\d{2})[\]\. ]+(?<tags>.*)-(?<group>\w*)(\.\w{3})?\z/i
+
+    attr_reader :filename, :showname, :season, :episode, :tags, :group
+
+    def initialize(filename)
+      @filename = filename
+      match = TVSHOW_REGEX.match basename
+      if match
+        @showname = match[:showname].gsub('.', ' ')
+        @season   = match[:season].to_i
+        @episode  = match[:episode].to_i
+        @tags     = match[:tags].upcase.split(/[\. ]/)
+        @group    = match[:group].upcase
+      else
+        raise InvalidFilename
+      end
+    end
+
+    # Lazy getters
+
+    def basename
+      @basename ||= File.basename(@filename)
+    end
+
+    def dirname
+      @dirname ||= File.dirname(@filename)
+    end
+
+    def extname
+      @extname ||= File.extname(@filename)
+    end
+
+    def to_s
+      @filename
+    end
+
+    def inspect
+"Guesses for #{@filename}:
+  show:    #{@showname}
+  season:  #{@season}
+  episode: #{@episode}
+  tags:    #{@tags}
+  group:   #{@group}"
+    end
+
+  end
+end

data/lib/addic7ed/subtitle.rb

@@ -0,0 +1,20 @@
+module Addic7ed
+  class Subtitle
+
+    attr_reader :version, :language, :status, :downloads
+    attr_accessor :url
+
+    def initialize(version, language, status, url, downloads)
+      @version   = version.upcase
+      @language  = language
+      @status    = status
+      @url       = url
+      @downloads = downloads.to_i
+    end
+
+    def to_s
+      "#{url}\t->\t#{@version} (#{language}, #{status}) [#{@downloads} downloads]"
+    end
+
+  end
+end

data/spec/addic7ed-common_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+require './lib/addic7ed'
+
+describe Addic7ed do
+  it 'should define SHOWS_URL' do
+    Addic7ed::SHOWS_URL.should_not be_nil
+  end
+  it 'should define EPISODES_URL' do
+    Addic7ed::EPISODES_URL.should_not be_nil
+  end
+  it 'should define EPISODE_REDIRECT_URL' do
+    Addic7ed::EPISODE_REDIRECT_URL.should_not be_nil
+  end
+  it 'should define LANGUAGES' do
+    Addic7ed::LANGUAGES.should_not be_nil
+    Addic7ed::LANGUAGES['fr'].should == {name: 'French', id: 8}
+  end
+end

data/spec/addic7ed-episode_spec.rb

@@ -0,0 +1,103 @@
+require 'spec_helper'
+require './lib/addic7ed'
+
+describe Addic7ed::Episode do
+  before :all do
+    @filename = 'Californication.S06E07.720p.HDTV.x264-2HD.mkv'
+    @filename_show_not_found = 'Show.Not.Found.S06E07.720p.HDTV.x264-2HD.mkv'
+    @filename_episode_not_found = 'Californication.S06E42.720p.HDTV.x264-2HD.mkv'
+  end
+
+  it 'should create valid instance given valid argument' do
+    expect{
+      @episode = Addic7ed::Episode.new(@filename)
+    }.to_not raise_error
+  end
+
+  describe '#url' do
+    before :all do
+      @episode = Addic7ed::Episode.new(@filename)
+    end
+    it 'should return a show localized URL given existing episode' do
+      @episode.url('fr').should == 'http://www.addic7ed.com/serie/Californication/6/7/8'
+      @episode.url('es').should == 'http://www.addic7ed.com/serie/Californication/6/7/4'
+    end
+    it 'should use French as default language' do
+      @episode.url.should == @episode.url('fr')
+    end
+    it 'should raise LanguageNotSupported given an unsupported language code' do
+      expect{
+        @episode.url('aa')
+      }.to raise_error(Addic7ed::LanguageNotSupported)
+    end
+  end
+
+  describe '#subtitles' do
+    before :all do
+      @filename = 'The.Walking.Dead.S03E02.720p.HDTV.x264-IMMERSE.mkv'
+      @episode = Addic7ed::Episode.new(@filename)
+    end
+    it 'should return an array of Addic7ed::Subtitle given valid episode and language' do
+      @episode.subtitles('fr').size.should == 4
+      @episode.subtitles('en').size.should == 3
+      @episode.subtitles('it').size.should == 1
+    end
+    it 'should use French as default language' do
+      @episode.subtitles.should == @episode.subtitles('fr')
+    end
+    it 'should raise LanguageNotSupported given an unsupported language code' do
+      expect{
+        @episode.subtitles('aa')
+      }.to raise_error(Addic7ed::LanguageNotSupported)
+    end
+    it 'should raise EpisodeNotFound given not existing episode' do
+      expect{
+        Addic7ed::Episode.new(@filename_episode_not_found).subtitles
+      }.to raise_error(Addic7ed::EpisodeNotFound)
+    end
+    it 'should raise NoSubtitleFound given valid episode which has no subtitle on Addic7ed' do
+      expect{
+        @episode.subtitles('es')
+      }.to raise_error(Addic7ed::NoSubtitleFound)
+    end
+    it 'may raise a ParsingError, but I don\'t know how to test it :-('
+    it 'may raise a WTFError, but it\'s unsure when, so it stays untested'
+  end
+
+  describe '#best_subtitle' do
+    before :all do
+      @filename = 'The.Walking.Dead.S03E03.720p.HDTV.x264-EVOLVE.mkv'
+      @filename_compatible_group = 'The.Walking.Dead.S03E06.720p.HDTV.x264-IMMERSE.mkv'
+      @episode = Addic7ed::Episode.new(@filename)
+    end
+    it 'should find the subtitle with status completed and same group name' do
+      @episode.best_subtitle('fr').url.should == 'http://www.addic7ed.com/updated/8/68290/2'
+    end
+    it 'should find the subtitle with status completed, compatible group name and as many downloads as possible' do
+      @episode = Addic7ed::Episode.new(@filename_compatible_group)
+      @episode.best_subtitle('fr').url.should == 'http://www.addic7ed.com/updated/8/68980/2'
+    end
+    it 'should use French as default language' do
+      @episode.best_subtitle.should == @episode.best_subtitle('fr')
+    end
+    it 'should raise LanguageNotSupported given an unsupported language code' do
+      expect{
+        @episode.best_subtitle('aa')
+      }.to raise_error(Addic7ed::LanguageNotSupported)
+    end
+    it 'should raise EpisodeNotFound given not existing episode' do
+      expect{
+        Addic7ed::Episode.new(@filename_episode_not_found).best_subtitle
+      }.to raise_error(Addic7ed::EpisodeNotFound)
+    end
+    it 'should raise NoSubtitleFound given valid episode which has no subtitle on Addic7ed' do
+      expect{
+        @episode.best_subtitle('es')
+      }.to raise_error(Addic7ed::NoSubtitleFound)
+    end
+  end
+
+  describe '#download_best_subtitle!' do
+    it 'should be tested, but I\'m not sure how to do it properly'
+  end
+end

data/spec/addic7ed-filename_spec.rb

@@ -0,0 +1,286 @@
+require 'spec_helper'
+require './lib/addic7ed'
+
+describe Addic7ed::Filename do
+
+  before :all do
+    # Valid filenames
+    @filename = 'Californication.S06E07.720p.HDTV.x264-2HD.mkv'
+    @filename_x = 'Californication.06x07.720p.HDTV.x264-2HD.mkv'
+    @filename_3digits = 'Californication.607.720p.HDTV.x264-2HD.mkv'
+    @filename_brackets = 'Californication.[S06E07].720p.HDTV.x264-2HD.mkv'
+    @filename_x_brackets = 'Californication.[6x07].720p.HDTV.x264-2HD.mkv'
+    @filename_3digits_brackets = 'Californication.[607].720p.HDTV.x264-2HD.mkv'
+    @filename_brackets_spaces = 'Californication [607] 720p.HDTV.x264-2HD.mkv'
+    @filename_x_brackets_spaces = 'Californication [6x07] 720p.HDTV.x264-2HD.mkv'
+    @filename_3digits_brackets_spaces = 'Californication [607] 720p.HDTV.x264-2HD.mkv'
+    @filename_lowercase = 'californication.s06e07.720p.hdtv.x264-2hd.mkv'
+    @filename_lowercase_x = 'californication.6x07.720p.hdtv.x264-2hd.mkv'
+    @filename_multiple_words = 'The.Walking.Dead.S03E11.720p.HDTV.x264-EVOLVE.mkv'
+    @filename_multiple_words_spaces = 'The Walking Dead S03E11 720p.HDTV.x264-EVOLVE.mkv'
+    @filename_numbers_only = '90210.S05E12.720p.HDTV.X264-DIMENSION.mkv'
+    @filename_showname_year = 'The.Americans.2013.S01E04.720p.HDTV.X264-DIMENSION.mkv'
+    @filename_full_path = '/data/public/Series/Californication/Saison 06/Californication.S06E07.720p.HDTV.x264-2HD.mkv'
+    @filename_relative_path = '../Saison 06/Californication.S06E07.720p.HDTV.x264-2HD.mkv'
+    @filename_no_extension = 'Californication.S06E07.720p.HDTV.x264-2HD'
+    # Invalid filenames
+    @filename_no_showname = '.S06E07.720p.HDTV.x264-2HD.mkv'
+    @filename_no_season = 'Californication.E07.720p.HDTV.x264-2HD.mkv'
+    @filename_no_episode = 'Californication.S06.720p.HDTV.x264-2HD.mkv'
+    @filename_no_tags = 'Californication.S06E07.2HD.mkv'
+    @filename_no_group = 'Californication.S06E07.720p.HDTV.x264.mkv'
+  end
+
+  it 'should succeed given valid argument' do
+    expect {
+      @file = Addic7ed::Filename.new(@filename)
+    }.to_not raise_error
+    @file.showname.should == 'Californication'
+    @file.season.should == 6
+    @file.episode.should == 7
+    @file.tags.should == ['720P', 'HDTV', 'X264']
+    @file.group.should == '2HD'
+  end
+
+  it 'should succeed given filename with x notation' do
+    expect {
+      @file = Addic7ed::Filename.new(@filename_x)
+    }.to_not raise_error
+    @file.showname.should == 'Californication'
+    @file.season.should == 6
+    @file.episode.should == 7
+    @file.tags.should == ['720P', 'HDTV', 'X264']
+    @file.group.should == '2HD'
+  end
+
+  it 'should succeed given filename with 3-digits notation' do
+    expect {
+      @file = Addic7ed::Filename.new(@filename_3digits)
+    }.to_not raise_error
+    @file.showname.should == 'Californication'
+    @file.season.should == 6
+    @file.episode.should == 7
+    @file.tags.should == ['720P', 'HDTV', 'X264']
+    @file.group.should == '2HD'
+  end
+
+  it 'should succeed given filename with brackets notation' do
+    expect {
+      @file = Addic7ed::Filename.new(@filename_brackets)
+    }.to_not raise_error
+    @file.showname.should == 'Californication'
+    @file.season.should == 6
+    @file.episode.should == 7
+    @file.tags.should == ['720P', 'HDTV', 'X264']
+    @file.group.should == '2HD'
+  end
+
+  it 'should succeed given filename with brackets and x notation' do
+    expect {
+      @file = Addic7ed::Filename.new(@filename_x_brackets)
+    }.to_not raise_error
+    @file.showname.should == 'Californication'
+    @file.season.should == 6
+    @file.episode.should == 7
+    @file.tags.should == ['720P', 'HDTV', 'X264']
+    @file.group.should == '2HD'
+  end
+
+  it 'should succeed given filename with brackets and 3-digits notation' do
+    expect {
+      @file = Addic7ed::Filename.new(@filename_3digits_brackets)
+    }.to_not raise_error
+    @file.showname.should == 'Californication'
+    @file.season.should == 6
+    @file.episode.should == 7
+    @file.tags.should == ['720P', 'HDTV', 'X264']
+    @file.group.should == '2HD'
+  end
+
+  it 'should succeed given filename with brackets notation and space separator' do
+    expect {
+      @file = Addic7ed::Filename.new(@filename_brackets_spaces)
+    }.to_not raise_error
+    @file.showname.should == 'Californication'
+    @file.season.should == 6
+    @file.episode.should == 7
+    @file.tags.should == ['720P', 'HDTV', 'X264']
+    @file.group.should == '2HD'
+  end
+
+  it 'should succeed given filename with brackets and x notation and space separator' do
+    expect {
+      @file = Addic7ed::Filename.new(@filename_x_brackets_spaces)
+    }.to_not raise_error
+    @file.showname.should == 'Californication'
+    @file.season.should == 6
+    @file.episode.should == 7
+    @file.tags.should == ['720P', 'HDTV', 'X264']
+    @file.group.should == '2HD'
+  end
+
+  it 'should succeed given filename with brackets and 3-digits notation and space separator' do
+    expect {
+      @file = Addic7ed::Filename.new(@filename_3digits_brackets_spaces)
+    }.to_not raise_error
+    @file.showname.should == 'Californication'
+    @file.season.should == 6
+    @file.episode.should == 7
+    @file.tags.should == ['720P', 'HDTV', 'X264']
+    @file.group.should == '2HD'
+  end
+
+  it 'should succeed given lowercase filename' do
+    expect {
+      @file = Addic7ed::Filename.new(@filename_lowercase)
+    }.to_not raise_error
+    @file.showname.should == 'californication'
+    @file.season.should == 6
+    @file.episode.should == 7
+    @file.tags.should == ['720P', 'HDTV', 'X264']
+    @file.group.should == '2HD'
+  end
+
+  it 'should succeed given lowercase filename with x notation' do
+    expect {
+      @file = Addic7ed::Filename.new(@filename_lowercase_x)
+    }.to_not raise_error
+    @file.showname.should == 'californication'
+    @file.season.should == 6
+    @file.episode.should == 7
+    @file.tags.should == ['720P', 'HDTV', 'X264']
+    @file.group.should == '2HD'
+  end
+
+  it 'should succeed given filename with showname containing multiple words' do
+    expect {
+      @file = Addic7ed::Filename.new(@filename_multiple_words)
+    }.to_not raise_error
+    @file.showname.should == 'The Walking Dead'
+    @file.season.should == 3
+    @file.episode.should == 11
+    @file.tags.should == ['720P', 'HDTV', 'X264']
+    @file.group.should == 'EVOLVE'
+  end
+
+  it 'should succeed given filename with showname containing multiple words with space separator' do
+    expect {
+      @file = Addic7ed::Filename.new(@filename_multiple_words_spaces)
+    }.to_not raise_error
+    @file.showname.should == 'The Walking Dead'
+    @file.season.should == 3
+    @file.episode.should == 11
+    @file.tags.should == ['720P', 'HDTV', 'X264']
+    @file.group.should == 'EVOLVE'
+  end
+
+  it 'should succeed given filename with showname containing only numbers' do
+    expect {
+      @file = Addic7ed::Filename.new(@filename_numbers_only)
+    }.to_not raise_error
+    @file.showname.should == '90210'
+    @file.season.should == 5
+    @file.episode.should == 12
+    @file.tags.should == ['720P', 'HDTV', 'X264']
+    @file.group.should == 'DIMENSION'
+  end
+
+  it 'should succeed given filename with showname containing production year' do
+    expect {
+      @file = Addic7ed::Filename.new(@filename_showname_year)
+    }.to_not raise_error
+    @file.showname.should == 'The Americans 2013'
+    @file.season.should == 1
+    @file.episode.should == 4
+    @file.tags.should == ['720P', 'HDTV', 'X264']
+    @file.group.should == 'DIMENSION'
+  end
+
+  it 'should succeed given filename containing full path' do
+    expect {
+      @file = Addic7ed::Filename.new(@filename_full_path)
+    }.to_not raise_error
+    @file.showname.should == 'Californication'
+    @file.season.should == 6
+    @file.episode.should == 7
+    @file.tags.should == ['720P', 'HDTV', 'X264']
+    @file.group.should == '2HD'
+  end
+
+  it 'should succeed given filename containing relative path' do
+    expect {
+      @file = Addic7ed::Filename.new(@filename_relative_path)
+    }.to_not raise_error
+    @file.showname.should == 'Californication'
+    @file.season.should == 6
+    @file.episode.should == 7
+    @file.tags.should == ['720P', 'HDTV', 'X264']
+    @file.group.should == '2HD'
+  end
+
+  it 'should succeed given filename containing no extension' do
+    expect {
+      @file = Addic7ed::Filename.new(@filename_no_extension)
+    }.to_not raise_error
+    @file.showname.should == 'Californication'
+    @file.season.should == 6
+    @file.episode.should == 7
+    @file.tags.should == ['720P', 'HDTV', 'X264']
+    @file.group.should == '2HD'
+  end
+
+  it 'should fail given filename with no showname' do
+    expect {
+      @file = Addic7ed::Filename.new(@filename_no_showname)
+    }.to raise_error
+  end
+
+  it 'should fail given filename with no season number' do
+    expect {
+      @file = Addic7ed::Filename.new(@filename_no_season)
+    }.to raise_error
+  end
+
+  it 'should raise InvalidFilename given filename with no episode number' do
+    expect {
+      @file = Addic7ed::Filename.new(@filename_no_episode)
+    }.to raise_error(Addic7ed::InvalidFilename)
+  end
+
+  it 'should raise InvalidFilename given filename with no tags' do
+    expect {
+      @file = Addic7ed::Filename.new(@filename_no_tags)
+    }.to raise_error(Addic7ed::InvalidFilename)
+  end
+
+  it 'should raise InvalidFilename given filename with no group' do
+    expect {
+      @file = Addic7ed::Filename.new(@filename_no_group)
+    }.to raise_error(Addic7ed::InvalidFilename)
+  end
+
+  describe '#basename' do
+    it 'should return only file name given a full path' do
+      Addic7ed::Filename.new(@filename_full_path).basename.should == 'Californication.S06E07.720p.HDTV.x264-2HD.mkv'
+    end
+  end
+
+  describe '#dirname' do
+    it 'should return only path given a full path' do
+      Addic7ed::Filename.new(@filename_full_path).dirname.should == '/data/public/Series/Californication/Saison 06'
+    end
+  end
+
+  describe '#extname' do
+    it 'should return only file extension given a full path' do
+      Addic7ed::Filename.new(@filename_full_path).extname.should == '.mkv'
+    end
+  end
+
+  describe '#to_s' do
+    it 'should return file name as a string' do
+      Addic7ed::Filename.new(@filename_full_path).to_s.should == '/data/public/Series/Californication/Saison 06/Californication.S06E07.720p.HDTV.x264-2HD.mkv'
+    end
+  end
+
+end