addic7ed 0.1.9 → 0.2.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MGFlY2ZmZmQxNjY4ZmE3ZmRkY2E1NzRiYjY3ZGYyN2I0NmZmNjViMg==
-  data.tar.gz: !binary |-
-    OWMxMzRlYjMwNDM0ZTUzMjVmOTRiM2I0NTg4ZDAwODFmYWQ5YWI2ZQ==
+SHA1:
+  metadata.gz: 57ad3d69c430c7a8a03656461871412130e86bc2
+  data.tar.gz: 45bcf71317aa9d27d21b4d899324dda51c0a2dbc
 SHA512:
-  metadata.gz: !binary |-
-    MGNiN2E1NDA1NjNiODg1YjA4YzhiN2FmMjMzNDY5NTlkNjIzYTcwMDczZDA5
-    MDE1N2FjNDQ5NTZkOGEyYjAyNDU2MWY5NTg1Yzg2NmYzZjBkZmNiOTVmNmUz
-    NDA5NTdlMmUwNDBiZWM1YjcyOTQxNmM5MjAxN2M3ZjAwMTY5OTA=
-  data.tar.gz: !binary |-
-    MWM3MjNhMTY5YmJiNDg4ZjlmZmRiMjViYTQ3ZTRiYmFhMWQ3MDdkMGNkMDQ4
-    YWNiOWQ1YWQ5YmUyZGExODEzYWRlMTQ3YzcxOWI2MGIxY2ExM2I5ZTYzN2E4
-    NjQ1ZThmZDZhYjQyNTIzYTAxMDRiMTI4N2FlZWZiNWY0Y2M4MWY=
+  metadata.gz: 3988226f6b255c145487c43410e5c288fe4c49f89480df759eb514a6ef8bddfa693c595d1517b30f81ebf6eb1e955f5c69955608bb25cbccfff2c66863d9c097
+  data.tar.gz: 967506087a44bd2865c0a8026ec401d37a86670bbcf218d8b7ef503258fe592f744d2ecb60a96210fbfc97626d9cf208a4ed4ca771a961805a04437a6d346e35

data/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (c) 2013 Michael Baudino
+
+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/bin/addic7ed

@@ -128,8 +128,8 @@ options[:filenames].each do |filename|
   rescue Addic7ed::SubtitleCannotBeSaved
     puts "The downloaded subtitle could not be saved as #{filename.gsub(/\.\w{3}$/, '.srt')}. Skipping.".gsub(/^/, options[:verbose] ? '  ' : '') unless options[:quiet]
     next
-  rescue Addic7ed::WTFError => e
-    puts "WTF (I sincerely have no idea what I'm doing): #{e.message}".gsub(/^/, options[:verbose] ? '  ' : '') unless options[:quiet]
+  rescue Addic7ed::HTTPError => e
+    puts "Network error: #{e.message}".gsub(/^/, options[:verbose] ? '  ' : '') unless options[:quiet]
     next
   end
 

data/lib/addic7ed.rb

@@ -4,3 +4,4 @@ require 'addic7ed/errors'
 require 'addic7ed/filename'
 require 'addic7ed/episode'
 require 'addic7ed/subtitle'
+require 'addic7ed/parser'

data/lib/addic7ed/episode.rb

@@ -1,4 +1,3 @@
-require 'nokogiri'
 require 'net/http'
 require 'open-uri'
 
@@ -12,95 +11,84 @@ module Addic7ed
     end
 
     def url(lang = 'fr')
-      raise LanguageNotSupported unless LANGUAGES[lang]
+      check_language_availability(lang)
       @localized_urls ||= {}
       @localized_urls[lang] ||= "http://www.addic7ed.com/serie/#{@filename.encoded_showname}/#{@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]
+      check_language_availability(lang)
+      find_subtitles(lang) unless @subtitles and @subtitles[lang]
+      return @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 or @best_subtitle[lang].via == 'http://addic7ed.com')
-          end
-        end
-        raise NoSubtitleFound unless @best_subtitle[lang]
-      end
+      check_language_availability(lang)
+      find_best_subtitle(lang) unless @best_subtitle and @best_subtitle[lang]
       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
-        raise DownloadError
-      end
+    def download_best_subtitle!(lang, http_redirect_limit = 8)
+      raise HTTPError.new('Too many HTTP redirects') unless http_redirect_limit > 0
+      uri = URI(best_subtitle(lang).url)
+      response = get_http_response(uri, url(lang))
       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'])
-         raise DownloadLimitReached if /^\/downloadexceeded.php/.match best_subtitle(lang).url
-         download_best_subtitle!(lang, redirect_limit - 1)
+        follow_redirection(lang, response['location'], http_redirect_limit)
       else
-        begin
-          open "#{filename}".gsub(/\.\w{3}$/, '.srt'), 'w' do |f|
-            f << response.body
-          end
-        rescue
-          raise SubtitleCannotBeSaved
-        end
+        save_subtitle response.body
       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').last
-        url = 'http://www.addic7ed.com' + url_node['href']
-        via_node = sub_node.css('tr:nth-child(3) td:first-child a').first
-        via = via_node['href'] if via_node
-        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, via, downloads)
-      rescue
-        raise ParsingError
+    def find_subtitles(lang)
+      initialize_language(lang)
+      parser = Addic7ed::Parser.new(self, lang)
+      @subtitles[lang] = parser.extract_subtitles
+    end
+
+    def find_best_subtitle(lang)
+      @best_subtitle ||= {}
+      subtitles(lang).each do |sub|
+        @best_subtitle[lang] = sub if sub.works_for? @filename.group and sub.can_replace? @best_subtitle[lang]
+      end
+      raise NoSubtitleFound unless @best_subtitle[lang]
+    end
+
+    def check_language_availability(lang)
+      raise LanguageNotSupported unless LANGUAGES[lang]
+    end
+
+    def initialize_language(lang)
+      @subtitles ||= {}
+      @subtitles[lang] ||= []
+    end
+
+    def get_http_response(uri, referer)
+      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.
+        request['Referer'] = referer
+        request['User-Agent'] = USER_AGENTS.sample
+        http.request(request)
+      end
+    rescue
+      raise DownloadError
+    end
+
+    def follow_redirection(lang, new_uri, http_redirect_limit)
+      # Addic7ed is serving redirection URL not-encoded, but Ruby does not support it (see http://bugs.ruby-lang.org/issues/7396)
+      best_subtitle(lang).url = URI.escape(new_uri)
+      raise DownloadLimitReached if /^\/downloadexceeded.php/.match best_subtitle(lang).url
+      download_best_subtitle!(lang, http_redirect_limit - 1)
+    end
+
+    def save_subtitle(content)
+      open "#{filename}".gsub(/\.\w{3}$/, '.srt'), 'w' do |f|
+        f << content
       end
+    rescue
+      raise SubtitleCannotBeSaved
     end
 
   end

data/lib/addic7ed/errors.rb

@@ -1,22 +1,9 @@
 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
+  exceptions = [
+    :InvalidFilename,       :ShowNotFound,    :EpisodeNotFound, :LanguageNotSupported,
+    :ParsingError,          :NoSubtitleFound, :DownloadError,   :DownloadLimitReached,
+    :SubtitleCannotBeSaved, :HTTPError
+  ]
+
+  exceptions.each { |e| const_set(e, Class.new(StandardError)) }
 end

data/lib/addic7ed/parser.rb

@@ -0,0 +1,86 @@
+require 'nokogiri'
+require 'net/http'
+require 'open-uri'
+
+module Addic7ed
+  class Parser
+
+    def initialize(episode, lang)
+      @episode, @lang = episode, lang
+      @subtitles = []
+    end
+
+    def extract_subtitles
+      @dom = subtitles_page_dom
+      check_subtitles_presence
+      parse_subtitle_nodes_list
+      @subtitles
+    end
+
+    protected
+
+    def subtitles_page_dom
+      response = Net::HTTP.get_response(URI(@episode.url(@lang)))
+      raise EpisodeNotFound unless response.body
+      Nokogiri::HTML(response.body)
+    end
+
+    def check_subtitles_presence
+      raise NoSubtitleFound unless @dom.css('select#filterlang ~ font[color="yellow"]').empty?
+    end
+
+    def parse_subtitle_nodes_list
+      sublist_node = @dom.css('#container95m table.tabel95 table.tabel95')
+      raise NoSubtitleFound if sublist_node.size == 0
+      sublist_node.each do |sub_node|
+        @subtitles << parse_subtitle_node(sub_node)
+      end
+    end
+
+    def parse_subtitle_node(sub_node)
+      version   = extract_version(sub_node)
+      language  = extract_language(sub_node)
+      status    = extract_status(sub_node)
+      url       = extract_url(sub_node)
+      source    = extract_source(sub_node)
+      downloads = extract_downloads(sub_node)
+      Addic7ed::Subtitle.new(version, language, status, url, source, downloads)
+    end
+
+    def extract_version(sub_node)
+      version_node = sub_node.css('.NewsTitle').first
+      raise Addic7ed::ParsingError unless version_node
+      version_node.content.gsub(/ \nVersion /, '').gsub(/,.*/, '')
+    end
+
+    def extract_language(sub_node)
+      language_node = sub_node.css('.language').first
+      raise Addic7ed::ParsingError unless language_node
+      language_node.content.gsub(/\A\W*/, '').gsub(/[^\w\)]*\z/, '')
+    end
+
+    def extract_status(sub_node)
+      status_node = sub_node.css('tr:nth-child(3) td:nth-child(4) b').first
+      raise Addic7ed::ParsingError unless status_node
+      status_node.content.strip
+    end
+
+    def extract_url(sub_node)
+      url_node = sub_node.css('a.buttonDownload').last
+      raise Addic7ed::ParsingError unless url_node
+      'http://www.addic7ed.com' + url_node['href']
+    end
+
+    def extract_source(sub_node)
+      source_node = sub_node.css('tr:nth-child(3) td:first-child a').first
+      source_node['href'] if source_node
+    end
+
+    def extract_downloads(sub_node)
+      downloads_node = sub_node.css('tr:nth-child(4) td.newsDate').first
+      raise Addic7ed::ParsingError unless downloads_node
+      /(?<downloads>\d*) Downloads/.match(downloads_node.content)[:downloads]
+    end
+
+  end
+end

data/lib/addic7ed/subtitle.rb

@@ -17,7 +17,19 @@ module Addic7ed
       "#{url}\t->\t#{@version} (#{language}, #{status}) [#{@downloads} downloads]#{" (via #{via})" if @via}"
     end
 
-    private
+    def works_for?(version = '')
+      is_completed? and is_compatible_with? version
+    end
+
+    def can_replace?(other_sub)
+      return false unless is_completed?
+      return true if other_sub.nil?
+      language == other_sub.language and
+      is_compatible_with? other_sub.version and
+      is_more_popular_than? other_sub
+    end
+
+    protected
 
     def normalized_version(version)
       version.
@@ -30,5 +42,21 @@ module Addic7ed
         upcase
     end
 
+    def is_completed?
+      status == 'Completed'
+    end
+
+    def is_compatible_with?(other_version)
+      version == other_version or
+      COMPATIBILITY_720P[version] == other_version or
+      COMPATIBILITY_720P[other_version] == version
+    end
+
+    def is_more_popular_than?(other_sub)
+      return true   if other_sub.nil?
+      return false  if other_sub.via == 'http://addic7ed.com'
+      return downloads > other_sub.downloads
+    end
+
   end
 end

data/lib/addic7ed/version.rb

@@ -1,3 +1,3 @@
 module Addic7ed
-  VERSION = '0.1.9'
+  VERSION = '0.2.0'
 end

data/spec/addic7ed-common_spec.rb

@@ -2,17 +2,22 @@ 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

@@ -2,10 +2,13 @@ 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'
+    @filename = 'The.Walking.Dead.S03E02.720p.HDTV.x264-EVOLVE.mkv'
+    @filename_show_not_found = 'Show.Not.Found.S03E02.720p.HDTV.x264-EVOLVE.mkv'
+    @filename_episode_not_found = 'The.Walking.Dead.S03E42.720p.HDTV.x264-EVOLVE.mkv'
+    @filename_compatible_group = 'The.Walking.Dead.S03E04.HDTV.XviD-ASAP.mkv'
+    @episode = Addic7ed::Episode.new(@filename)
   end
 
   it 'should create valid instance given valid argument' do
@@ -15,89 +18,106 @@ describe Addic7ed::Episode do
   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'
+      @episode.url('fr').should == 'http://www.addic7ed.com/serie/The_Walking_Dead/3/2/8'
+      @episode.url('es').should == 'http://www.addic7ed.com/serie/The_Walking_Dead/3/2/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
+      ['fr', 'en', 'it'].each do |lang|
+        lang_id = Addic7ed::LANGUAGES[lang][:id]
+        stub_request(:get, "http://www.addic7ed.com/serie/The_Walking_Dead/3/2/#{lang_id}")
+          .to_return File.new("spec/responses/walking-dead-3-2-#{lang_id}.http")
+      end
       @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
+      stub_request(:get, 'http://www.addic7ed.com/serie/The_Walking_Dead/3/42/8')
+        .to_return File.new('spec/responses/walking-dead-3-42-8.http')
       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
+      stub_request(:get, 'http://www.addic7ed.com/serie/The_Walking_Dead/3/2/48')
+        .to_return File.new('spec/responses/walking-dead-3-2-48.http')
       expect{
-        @episode.subtitles('es')
+        @episode.subtitles('az')
       }.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'
+      stub_request(:get, 'http://www.addic7ed.com/serie/The_Walking_Dead/3/2/8')
+        .to_return File.new('spec/responses/walking-dead-3-2-8.http')
+      @episode.best_subtitle('fr').url.should == 'http://www.addic7ed.com/original/68018/4'
     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'
+      stub_request(:get, 'http://www.addic7ed.com/serie/The_Walking_Dead/3/4/8')
+        .to_return File.new('spec/responses/walking-dead-3-4-8.http')
+      compatible_episode = Addic7ed::Episode.new(@filename_compatible_group)
+      compatible_episode.best_subtitle('fr').url.should == 'http://www.addic7ed.com/updated/8/68508/3'
     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
+      stub_request(:get, 'http://www.addic7ed.com/serie/The_Walking_Dead/3/2/48')
+        .to_return File.new('spec/responses/walking-dead-3-2-48.http')
       expect{
-        @episode.best_subtitle('es')
+        @episode.best_subtitle('az')
       }.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