download_tv 2.6.5 → 2.6.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3bb73c3cccddd294060908acd7d79d619b1af0927aa51b5c7b7ac04aff6dd20
-  data.tar.gz: ea159d175a5bcdc1bdf71c35264756ee41d7da2d9b53aa7169258c37926279cf
+  metadata.gz: 2cd494e098abb85a02a4a7182e66aef862aa14a04e73bd0c38f2e3a8991c1954
+  data.tar.gz: 275eccd2336a88bda38cd0711d169b7e95b9fd492164ae033b199b8d08eb4f32
 SHA512:
-  metadata.gz: f052f503bea9ceec1c5010b174680cd9efeb5f657d0db0747018cc232c2a66468e394a574776231472cb3506adf0f3a01def502e0adaa9dd86aa39a42e3328d4
-  data.tar.gz: 3a5d5d52294d770adc7c73879568c3ccfb88d7e88110bb78d02e7671b883cf8be88ad4e54e2c951d15f8508529d464b5014b4525068982c88598d80ae037830c
+  metadata.gz: 884a973095e183b1499839d3b68f01e0ba475ae6ea1220f7a5a98d9f3427892bb78c5404aedc2cbdab6f8f157b9a84729ebd75a1aaef37b5a389670f98e67c40
+  data.tar.gz: 2a1d58fb22524127f7fe42040a652473f0146aaa7ea6a7c45fc6af35800d4c09e45ed821ec6ebd8c343e76952af3ec4a4771dfb5986c9f64bbf764347c0bc267

data/.github/workflows/ruby.yml

@@ -32,4 +32,4 @@ jobs:
         ruby-version: ${{ matrix.ruby-version }}
         bundler-cache: true # runs 'bundle install' and caches installed gems automatically
     - name: Run tests
-      run: bundle exec rake
+      run: bundle exec rspec

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # download_tv CHANGELOG
 
+## 2.6.7 (2022-10-22)
+
+* Features
+	* Add `--healthcheck` to check the status of all the grabbers (online/offline).
+
+* Fixes
+	* Better detection for offline grabbers without crashing the app
+
+* Grabbers
+	* Torrentz: Fix parser
+
+## 2.6.6 (2022-01-21)
+
+* Improvements
+	* The `--dry-run` option now prevents from persisting any configuration, including pending shows, not just the last execution date.
+	* Performance improvements when running with the `-t` flag.
+
 ## 2.6.5 (2021-06-10)
 
 * Fixes

data/Gemfile

@@ -3,3 +3,5 @@
 source 'https://rubygems.org'
 
 gemspec
+
+gem "rspec", "~> 3.11"

data/README.md

@@ -6,13 +6,13 @@
 
 **download_tv** is a tool that allows the user to find magnet links for TV show episodes. It accepts shows as arguments, from a file or it can integrate with your MyEpisodes account.
 
-### Installation
+## Installation
 
 `gem install download_tv`
 
-### Usage
+## Usage
 
-Once installed, you can launch the binary *tv*
+Once installed, you can launch the binary `tv`
 
 ```
 Usage: tv [options]
@@ -29,6 +29,7 @@ Specific options:
     -a, --[no-]auto                  Automatically find links
     -g, --grabber GRABBER            Use given grabber as first option
         --show-grabbers              List available grabbers
+        --healthcheck                Check status of all the grabbers
     -p, --pending                    Show list of pending downloads
         --clear-pending              Clear list of pending downloads
     -q, --queue SHOW                 Add show episode to pending downloads list
@@ -86,6 +87,10 @@ Upon installation, the default filters exclude 2060p, 1080p or 720p, and include
 
 Keep in mind that this is not a hard filter. The application will sequentially apply as many user-defined filters as possible **while still returning at least one result**.
 
-### License
+## Shell completion
+
+The provided binary will print completion files to STDOUT by passing the options `--*-completion-bash` and `--*-completion-zsh` (you might have to escape the asterisk). Use your shell's manual to find out how to load these files to get completions.
+
+## License
 
 This project is released under the terms of the MIT license. See [LICENSE.md](https://github.com/guille/download_tv/blob/master/LICENSE.md) file for details.

data/bin/tv

@@ -47,7 +47,7 @@ opt_parser = OptionParser.new do |opts|
     options[:cmd] = 'showconfig'
   end
 
-  opts.on('--dry-run', "Don't write to the date file") do |n|
+  opts.on('--dry-run', "Don't update the persisted configuration") do |n|
     options[:dry] = n
   end
 
@@ -60,7 +60,12 @@ opt_parser = OptionParser.new do |opts|
   end
 
   opts.on('--show-grabbers', 'List available grabbers') do
-    puts DownloadTV::Torrent.new.grabbers
+    puts DownloadTV::Torrent.grabbers
+    exit
+  end
+
+  opts.on('--healthcheck', 'Check status of all the grabbers') do
+    DownloadTV::Torrent.healthcheck
     exit
   end
 
@@ -117,9 +122,9 @@ begin
   when 'config'
     DownloadTV::Configuration.new(config).change_configuration
   when 'showconfig'
-    DownloadTV::Configuration.new(config).print_config
+    puts DownloadTV::Configuration.new(config)
   when 'showpending'
-    DownloadTV::Configuration.new(config).print_attr(:pending)
+    puts DownloadTV::Configuration.new(config)[:pending]
   when 'clearpending'
     DownloadTV::Configuration.new(config).clear_pending
   when 'queue'

data/lib/download_tv/configuration.rb

@@ -4,134 +4,160 @@ module DownloadTV
   ##
   # Class used for managing the configuration of the application
   class Configuration
-    attr_reader :content, :config_path
+    def initialize(user_config = {})
+      load_config(user_config)
+    end
+
+    def [](key)
+      @content[key]
+    end
+
+    def []=(key, value)
+      @content[key] = value
+    end
+
+    def change_configuration
+      prompt_for_new_values
+      set_default_values
+      serialize
+    end
+
+    def serialize
+      self[:pending] = self[:pending].uniq
+      File.write(config_path, JSON.generate(@content))
+    end
+
+    def to_s
+      @content.reduce('') do |mem, item|
+        key, val = item
+        "#{mem}#{key}: #{val}\n"
+      end
+    end
+
+    def clear_pending
+      self[:pending].clear
+      serialize
+    end
+
+    def queue_pending(show)
+      self[:pending] << show
+      serialize
+    end
+
+    private
 
-    def initialize(content = {})
-      @config_path = content[:path] || default_config_path
-      FileUtils.mkdir_p(File.expand_path('..', @config_path))
+    def content
+      @content ||= {}
+    end
 
-      if File.exist? @config_path
-        load_config
-        @content.merge!(content) unless content.empty?
-        @content[:ignored]&.map!(&:downcase)
+    def load_config(user_config)
+      if File.exist? config_path
+        parse_config
       else
-        @content = content
+        FileUtils.mkdir_p(File.expand_path('..', config_path))
         change_configuration
       end
+      content.merge!(user_config) unless user_config.empty?
+      self[:ignored]&.map!(&:downcase)
     end
 
-    def change_configuration
+    def parse_config
+      source = File.read(config_path)
+      @content = JSON.parse(source, symbolize_names: true)
+
+      self[:date] = Date.parse(self[:date]) if self[:date]
+
+      if !self[:version] || breaking_changes?(self[:version])
+        warn 'Change configuration required (version with breaking changes detected)'
+        change_configuration
+      end
+    rescue JSON::ParserError => e
+      warn "Error parsing config file at #{config_path} => #{e.message}"
+      change_configuration
+    end
+
+    ##
+    # Returns true if a major or minor update has been detected, or if the config version is newer
+    # than the installed version. Returns something falsy otherwise
+    def breaking_changes?(version)
+      paired = DownloadTV::VERSION.split('.')
+                                  .map(&:to_i)
+                                  .zip(version.split('.').map(&:to_i))
+      # The configuration belongs to a newer version than is installed
+      return true unless paired.find_index { |x, y| x < y }.nil?
+
+      paired.find_index { |x, y| y < x }&.< 2
+    end
+
+    def prompt_for_new_values
       prompt_for_myep_user
       prompt_for_cookie
       prompt_for_ignored
       prompt_for_filters
       $stdout.flush
-
-      set_default_values
-      serialize
     end
 
     def prompt_for_myep_user
-      existing = "(#{@content[:myepisodes_user]}) " if @content[:myepisodes_user]
+      existing = "(#{self[:myepisodes_user]}) " if self[:myepisodes_user]
       print "Enter your MyEpisodes username #{existing}: "
       input = $stdin.gets.chomp
-      @content[:myepisodes_user] = input if input
+      self[:myepisodes_user] = input if input
     end
 
     def prompt_for_cookie
       print 'Save cookie? (y)/n: '
-      @content[:cookie] = !($stdin.gets.chomp.casecmp? 'n')
+      self[:cookie] = !($stdin.gets.chomp.casecmp? 'n')
     end
 
     def prompt_for_ignored
-      existing = "(#{@content[:ignored]})" if @content[:ignored]
+      existing = "(#{self[:ignored]})" if self[:ignored]
       puts "Enter a comma-separated list of shows to ignore: #{existing}"
 
-      @content[:ignored] = read_and_split_list :downcase
+      self[:ignored] = read_and_split_list :downcase
     end
 
     def prompt_for_filters
-      puts "Current filters: (#{@content[:filters]})" if @content[:filters]
-      @content[:filters] = {}
+      puts "Current filters: (#{self[:filters]})" if self[:filters]
+      self[:filters] = {}
 
       puts 'Enter a comma-separated list of terms to include: '
-      @content[:filters][:includes] = read_and_split_list :upcase
+      self[:filters][:includes] = read_and_split_list :upcase
 
       puts 'Enter a comma-separated list of terms to exclude: '
-      @content[:filters][:excludes] = read_and_split_list :upcase
+      self[:filters][:excludes] = read_and_split_list :upcase
     end
 
-    def read_and_split_list(case_method)
-      $stdin.gets.chomp.split(',')
-            .map(&:strip)
-            .map(&case_method)
+    def config_path
+      (content[:path] || default_config_path)
     end
 
-    def default_filters
-      {
-        'includes' => %w[PROPER REPACK],
-        'excludes' => %w[2160P 1080P 720P]
-      }
+    def default_config_path
+      File.join(ENV['HOME'], '.config', 'download_tv', 'config')
     end
 
     ##
     # Update the +content+ attribute with the defaults, if needed.
     # Maintains the previous values, in case it's an update from an existing file.
     def set_default_values
-      @content[:auto] ||= true
-      @content[:grabber] ||= 'TorrentAPI'
-      @content[:date] ||= Date.today - 1
-      @content[:filters] ||= default_filters
-      @content[:pending] ||= []
-      @content[:version] = DownloadTV::VERSION
-    end
-
-    def serialize
-      @content[:pending] = @content[:pending].uniq
-      File.write(@config_path, JSON.generate(@content))
-    end
-
-    def load_config
-      source = File.read(@config_path)
-      @content = JSON.parse(source, symbolize_names: true)
-
-      @content[:date] = Date.parse(@content[:date]) if @content[:date]
-
-      change_configuration if !@content[:version] || breaking_changes?(@content[:version])
-    rescue JSON::ParserError
-      @content = {}
-      change_configuration
-    end
-
-    def default_config_path
-      File.join(ENV['HOME'], '.config', 'download_tv', 'config')
-    end
-
-    ##
-    # Returns true if a major or minor update has been detected, something falsy otherwise
-    def breaking_changes?(version)
-      DownloadTV::VERSION.split('.')
-                         .zip(version.split('.'))
-                         .find_index { |x, y| y < x }
-                         &.< 2
+      self[:auto] ||= true
+      self[:grabber] ||= 'TorrentAPI'
+      self[:date] ||= Date.today - 1
+      self[:filters] ||= default_filters
+      self[:pending] ||= []
+      self[:version] = DownloadTV::VERSION
     end
 
-    def print_config
-      @content.each { |k, v| puts "#{k}: #{v}" }
-    end
-
-    def print_attr(arg)
-      puts @content[arg]
-    end
-
-    def clear_pending
-      @content[:pending].clear
-      serialize
+    def default_filters
+      {
+        'includes' => %w[PROPER REPACK],
+        'excludes' => %w[2160P 1080P 720P]
+      }
     end
 
-    def queue_pending(show)
-      @content[:pending] << show
-      serialize
+    def read_and_split_list(case_method)
+      $stdin.gets.chomp.split(',')
+            .map(&:strip)
+            .map(&case_method)
     end
   end
 end

data/lib/download_tv/downloader.rb

@@ -16,7 +16,7 @@ module DownloadTV
     # Tries to download episodes in order for a given season,
     # until it can't find any
     def download_entire_season(show, season)
-      t = Torrent.new(@config.content[:grabber])
+      t = Torrent.new(@config[:grabber])
       season.insert(0, '0') if season.size == 1
       episode = "#{show} s#{season}e01"
       loop do
@@ -29,7 +29,7 @@ module DownloadTV
     end
 
     def download_single_show(show, season = nil)
-      t = Torrent.new(@config.content[:grabber])
+      t = Torrent.new(@config[:grabber])
       show = fix_names([show]).first
       if season
         download_entire_season(show, season)
@@ -44,7 +44,7 @@ module DownloadTV
     def download_from_file(filename)
       if File.exist? filename
         filename = File.realpath(filename)
-        t = Torrent.new(@config.content[:grabber])
+        t = Torrent.new(@config[:grabber])
         to_download = File.readlines(filename, chomp: true)
         fix_names(to_download).each { |show| download(get_link(t, show)) }
       else
@@ -56,7 +56,7 @@ module DownloadTV
     ##
     # Returns the date from which to check shows
     def date_to_check_from(offset)
-      return @config.content[:date] if offset.zero?
+      return @config[:date] if offset.zero?
 
       Date.today - offset
     end
@@ -66,17 +66,16 @@ module DownloadTV
     # the last run of the program
     # It connects to MyEpisodes in order to find which shows
     # to track and which new episodes aired.
-    # The param +dont_update_last_run+ prevents changing the configuration's date value
+    # The param +dry_run+ prevents changing the persisted configuration
     # The param +offset+ can be used to move the date back that many days in the check
     # The param +include_tomorrow+ will add the current day to the list of dates to search
-    def run(dont_update_last_run, offset = 0, include_tomorrow: false)
-      pending = @config.content[:pending].clone
-      @config.content[:pending].clear
+    def run(dry_run = false, offset = 0, include_tomorrow: false)
+      pending = @config[:pending].clone
+      @config[:pending].clear
       pending ||= []
       date = date_to_check_from(offset)
 
-      pending.concat shows_to_download(date) if date < Date.today
-      pending.concat today_shows_to_download if include_tomorrow && date < Date.today.next
+      pending.concat shows_to_download(date, include_tomorrow) if date < (include_tomorrow ? Date.today.next : Date.today)
 
       if pending.empty?
         puts 'Nothing to download'
@@ -85,14 +84,14 @@ module DownloadTV
         puts 'Completed. Exiting...'
       end
 
-      unless dont_update_last_run
-        @config.content[:date] = if include_tomorrow
+      unless dry_run
+        @config[:date] = if include_tomorrow
                                    Date.today.next
                                  else
-                                   [Date.today, @config.content[:date]].max
+                                   [Date.today, @config[:date]].max
                                  end
+        @config.serialize
       end
-      @config.serialize
     rescue InvalidLoginError
       warn 'Wrong username/password combination'
     end
@@ -126,20 +125,10 @@ module DownloadTV
       download_t.join
     end
 
-    def shows_to_download(date)
-      myepisodes = MyEpisodes.new(@config.content[:myepisodes_user],
-                                  @config.content[:cookie])
-      myepisodes.load_cookie
-      shows = myepisodes.get_shows_since(date)
-      shows = reject_ignored(shows)
-      fix_names(shows)
-    end
-
-    def today_shows_to_download
-      myepisodes = MyEpisodes.new(@config.content[:myepisodes_user],
-                                  @config.content[:cookie])
-      myepisodes.load_cookie
-      shows = myepisodes.today_shows
+    def shows_to_download(date, include_tomorrow)
+      myepisodes = MyEpisodes.new(@config[:myepisodes_user],
+                                  @config[:cookie])
+      shows = myepisodes.get_shows_since(date, include_tomorrow: include_tomorrow)
       shows = reject_ignored(shows)
       fix_names(shows)
     end
@@ -154,11 +143,11 @@ module DownloadTV
       links = torrent.get_links(show)
 
       if links.empty?
-        @config.content[:pending] << show if save_pending
+        @config[:pending] << show if save_pending
         return
       end
 
-      if @config.content[:auto]
+      if @config[:auto]
         filter_shows(links).first[1]
       else
         prompt_links(links)
@@ -191,7 +180,7 @@ module DownloadTV
     def reject_ignored(shows)
       shows.reject do |i|
         # Remove season+episode
-        @config.content[:ignored]
+        @config[:ignored]
                .include?(i.split(' ')[0..-2].join(' ').downcase)
       end
     end
@@ -209,7 +198,7 @@ module DownloadTV
     # Runs until no filters are left to be applied or applying
     # a filter would leave no results
     def filter_shows(links)
-      @filterer ||= Filterer.new(@config.content[:filters])
+      @filterer ||= Filterer.new(@config[:filters])
       @filterer.filter(links)
     end
 

data/lib/download_tv/filterer.rb

@@ -4,28 +4,11 @@ module DownloadTV
   ##
   # Builds and applies filters to the results
   class Filterer
-    attr_reader :filters
-
     def initialize(filters_config)
       @filters = []
       build_filters(filters_config)
     end
 
-    def build_include_filter(str)
-      @filters << ->(n) { !n.upcase.include?(str) }
-    end
-
-    def build_exclude_filter(str)
-      @filters << ->(n) { n.upcase.include?(str) }
-    end
-
-    def build_filters(filters_config)
-      return unless filters_config
-
-      filters_config[:includes].map { |i| build_include_filter(i) }
-      filters_config[:excludes].map { |i| build_exclude_filter(i) }
-    end
-
     ##
     # Iteratively applies filters until they've all been applied
     # or applying the next filter would result in no results
@@ -41,5 +24,22 @@ module DownloadTV
 
       shows
     end
+
+    private
+
+    def build_filters(filters_config)
+      return unless filters_config
+
+      filters_config[:includes].map { |i| build_include_filter(i) }
+      filters_config[:excludes].map { |i| build_exclude_filter(i) }
+    end
+
+    def build_include_filter(str)
+      @filters << ->(n) { !n.upcase.include?(str) }
+    end
+
+    def build_exclude_filter(str)
+      @filters << ->(n) { n.upcase.include?(str) }
+    end
   end
 end

data/lib/download_tv/grabbers/eztv.rb

@@ -9,7 +9,7 @@ module DownloadTV
     end
 
     def get_links(show)
-      raw_data = @agent.get(format(@url, show))
+      raw_data = agent.get(format(@url, show))
       raw_seeders = raw_data.search('td.forum_thread_post_end').map { |e| e.children[0].text.to_i }
       raw_links = raw_data.search('a.magnet').sort_by.with_index { |_, index| raw_seeders[index] }.reverse
 

data/lib/download_tv/grabbers/torrentapi.rb

@@ -35,7 +35,7 @@ module DownloadTV
     # Makes a get request tp the given url.
     # Returns the JSON response parsed into a hash
     def request_and_parse(url)
-      page = @agent.get(url).content
+      page = agent.get(url).content
       JSON.parse(page)
     end
 

data/lib/download_tv/grabbers/torrentz.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module DownloadTV
+  ##
+  # Torrentz2 grabber
+  class Torrentz < LinkGrabber
+    def initialize
+      super('https://torrentz2.nz/search?q=%s')
+    end
+
+    def get_links(show)
+      raw_data = agent.get(format(@url, show))
+      results = raw_data.search('dl')
+
+      raise NoTorrentsError if results.empty?
+
+      data = results.sort_by { |e| e.search('dd span')[3].text.to_i }.reverse
+
+      data.collect do |i|
+        [i.children[0].text.strip,
+         i.search('dd span a').first.attribute('href').text]
+      end
+    end
+  end
+end

data/lib/download_tv/grabbers/tpb.rb

@@ -14,7 +14,7 @@ module DownloadTV
       search = format(@url, show)
 
       # Skip the header
-      data = @agent.get(search).search('#searchResult tr').drop 1
+      data = agent.get(search).search('#searchResult tr').drop 1
 
       raise NoTorrentsError if data.empty?
 

data/lib/download_tv/linkgrabber.rb

@@ -8,7 +8,10 @@ module DownloadTV
 
     def initialize(url)
       @url = url
-      @agent = Mechanize.new do |a|
+    end
+
+    def agent
+      @agent ||= Mechanize.new do |a|
         a.user_agent = DownloadTV::USER_AGENT
         a.read_timeout = 10
       end
@@ -20,9 +23,9 @@ module DownloadTV
             else
               @url
             end
-      @agent.head(url)
+      agent.head(url)
       true
-    rescue Mechanize::ResponseCodeError, Net::HTTP::Persistent::Error, Errno::ECONNRESET
+    rescue Mechanize::ResponseCodeError, Net::HTTP::Persistent::Error, Errno::ECONNRESET, Net::ReadTimeout, OpenSSL::SSL::SSLError
       false
     end