download_tv 2.5.4 → 2.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14480f4df75d1bd924641e70896710bdbaadbd61e7cdc2988c802f094c5841e1
-  data.tar.gz: cdee66d0f1c699e56b2b48c3376d4654ded93d17d6ea5851acf79e728e1b792e
+  metadata.gz: 4054ab9c742ef1b4a8966b4a8e0f6adfb124142da744827e034e39574b2bc1e4
+  data.tar.gz: 947049650860802c48eb0adcea1299caf1416e10cd5c1fab0a27d2f553dfb4f7
 SHA512:
-  metadata.gz: e65a989bc27f5741d656ea853f660fc50e2c2fd46fcb03794e50afd03f47b698b354d73845b940b03f6809d31cd5bf84108627ebb09410bb76c924cc36964730
-  data.tar.gz: 27afaf52a2aa2c699d7f95333aefcb8c3c622e3c9b2a1e1cce801fb9705f4f5824d9e16a5e6b01585960f9f0f3b4fd464e64e5ecafab2b5ed6e2ed9242e9e897
+  metadata.gz: 4e723e145e18922ee3bea26ac69db06c94c55e87f80059041c51486648469014c54fc1e1e08a77f369d3a85d04abe1e8b0958613b13d395f2d074188ed4190f1
+  data.tar.gz: 2943f772dee6e8bb4a18c8086af317dc450e3453ff5dbef17886dc33442e0fd78aadc28928a218b3bdc9067d95f12e6af64f5144a82f5ca75c91625782456654

data/README.md

@@ -42,11 +42,13 @@ By default, download_tv connects to your MyEpisodes.com account and fetches the
 
 The -o flag can be used in order to re-download the episodes from previous days. The --dry-run option is useful to prevent download_tv from updating the date (for example, when running the application shortly after an episode airs).
 
+Starting in version 2.5.4, download_tv includes the --tomorrow flag. By default, an execution of download_tv will download shows airing from the last execution of the program up to a day prior to the current day. Use this flag to include shows airing today in this search. This can be useful depending on your timezone or on the airtime of the shows you follow.
+
 **Note**: Due to API limitations, the gem won't find shows aired more than 14 days prior to the execution of the script.
 
 The options -c and --show-config allow the user to change or view the current configuration values, respectively. These options include your myepisodes username, whether to save cookies or ask for password on each run and the list of ignored shows among other things. The configuration files are (mostly) backwards compatible. The gem will force you to change your configuration after an update if there are breaking changes in it.
 
-The `auto` flag toggles whether all the results for each show are prompted to the user for him to choose or if the application should try to choose the download link automatically (by default, prioritizes PROPER/REPACK releases at 480p).
+The `auto` flag toggles whether all the results for each show are prompted to the user for him to choose or if the application should try to choose the download link automatically (see Section Filters).
 
 ### Single torrent download
 
@@ -70,6 +72,14 @@ I usually publish a patch update to the gem when I detect one of them isn't work
 
 download_tv version 2.5.0 persists the list of shows it can't find on a given execution (when connecting to MyEpisodes, not for single show or file downloads) and it will try to find them again on following executions. This list can be viewed by passing the -p flag to the tv binary. The list can be cleared with the --clear-pending option.
 
+### Filters
+
+download_tv version 2.5.5 adds the possibility of setting include/exclude filters for the automatic download of shows.
+
+Up until that version, the filters by default were excluding 1080p or 720p, as well as including PROPER or REPACK releases when available. From that version onwards, the user can specify in their configuration (`tv -c`) a list of words to include or exclude from their results.
+
+Please keep in mind that this is not a hard filter. The application will apply as many user-defined filters as possible **while still returning at least one result**.
+
 ### 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.
+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/download_tv.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |s|
 
   s.executables = ['tv']
 
-  s.add_development_dependency 'bundler', '~> 1.15'
+  s.add_development_dependency 'bundler', '~> 2.0'
   s.add_development_dependency 'minitest', '~> 5.0'
   s.add_development_dependency 'rake', '~> 10.0'
 

data/lib/download_tv.rb

@@ -11,6 +11,7 @@ require 'download_tv/version'
 require 'download_tv/configuration'
 require 'download_tv/downloader'
 require 'download_tv/torrent'
+require 'download_tv/filterer'
 require 'download_tv/myepisodes'
 require 'download_tv/linkgrabber'
 require 'download_tv/subtitles'

data/lib/download_tv/configuration.rb

@@ -25,6 +25,7 @@ module DownloadTV
       prompt_for_myep_user
       prompt_for_cookie
       prompt_for_ignored
+      prompt_for_filters
       STDOUT.flush
 
       set_default_values
@@ -37,7 +38,8 @@ module DownloadTV
       else
         print 'Enter your MyEpisodes username: '
       end
-      @content[:myepisodes_user] = STDIN.gets.chomp
+      input = STDIN.gets.chomp
+      @content[:myepisodes_user] = input if input
     end
 
     def prompt_for_cookie
@@ -59,6 +61,35 @@ module DownloadTV
                                 .map(&:downcase)
     end
 
+    def prompt_for_filters
+      puts "Current filters: (#{@content[:filters]})" if @content[:filters]
+
+      @content[:filters] = {}
+
+      puts 'Enter a comma-separated list of terms to include: '
+
+      @content[:filters][:includes] = STDIN.gets
+                                           .chomp
+                                           .split(',')
+                                           .map(&:strip)
+                                           .map(&:upcase)
+
+      puts 'Enter a comma-separated list of terms to exclude: '
+
+      @content[:filters][:excludes] = STDIN.gets
+                                           .chomp
+                                           .split(',')
+                                           .map(&:strip)
+                                           .map(&:upcase)
+    end
+
+    def default_filters
+      {
+        'includes' => %w[PROPER REPACK],
+        'excludes' => %w[2160P 1080P 720P]
+      }
+    end
+
     def set_default_values
       # When modifying existing config, keeps previous values
       # When creating new one, sets defaults
@@ -66,6 +97,7 @@ module DownloadTV
       @content[:subs] ||= true
       @content[:grabber] ||= 'TorrentAPI'
       @content[:date] ||= Date.today - 1
+      @content[:filters] ||= default_filters
       @content[:pending] ||= []
       @content[:version] = DownloadTV::VERSION
     end

data/lib/download_tv/downloader.rb

@@ -9,14 +9,6 @@ module DownloadTV
     def initialize(config = {})
       @config = Configuration.new(config) # Load configuration
 
-      @filters = [
-        ->(n) { n.include?('2160p') },
-        ->(n) { n.include?('1080p') },
-        ->(n) { n.include?('720p')  },
-        # ->(n) { n.include?('WEB')   },
-        ->(n) { !n.include?('PROPER') && !n.include?('REPACK') }
-      ]
-
       Thread.abort_on_exception = true
     end
 
@@ -86,7 +78,12 @@ module DownloadTV
       @config.content[:pending].clear
       pending ||= []
 
-      # Has the program already been run with --tomorrow
+      # Make normal run first if necessary
+      if @config.content[:date] < Date.today
+        pending.concat shows_to_download(@config.content[:date])
+      end
+
+      # Only do --tomorrow run if it hasn't happened already
       if @config.content[:date] < Date.today.next
         pending.concat today_shows_to_download
       end
@@ -227,19 +224,12 @@ module DownloadTV
     end
 
     ##
-    # Iteratively applies filters until they've all been applied
-    # or applying the next filter would result in no results
-    # These filters are defined at @filters
+    # Removes links whose names don't match the user filters
+    # Runs until no filters are left to be applied or applying
+    # a filter would leave no results
     def filter_shows(links)
-      @filters.each do |f| # Apply each filter
-        new_links = links.reject { |name, _link| f.call(name) }
-        # Stop if the filter removes every release
-        break if new_links.empty?
-
-        links = new_links
-      end
-
-      links
+      f = Filterer.new(@config.content[:filters])
+      f.filter(links)
     end
 
     ##

data/lib/download_tv/filterer.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+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
+    def filter(shows)
+      # shows is tuple (show name, link)
+      @filters.each do |f|
+        new_shows = shows.reject { |name, _link| f.call(name) }
+        # Go to next filter if the filter removes every release
+        next if new_shows.empty?
+
+        shows = new_shows
+      end
+
+      shows
+    end
+  end
+end

data/lib/download_tv/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DownloadTV
-  VERSION = '2.5.4'
+  VERSION = '2.5.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: download_tv
 version: !ruby/object:Gem::Version
-  version: 2.5.4
+  version: 2.5.5
 platform: ruby
 authors:
 - guille
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-19 00:00:00.000000000 Z
+date: 2019-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -99,6 +99,7 @@ files:
 - lib/download_tv.rb
 - lib/download_tv/configuration.rb
 - lib/download_tv/downloader.rb
+- lib/download_tv/filterer.rb
 - lib/download_tv/grabbers/addic7ed.rb
 - lib/download_tv/grabbers/eztv.rb
 - lib/download_tv/grabbers/kat.rb
@@ -133,8 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: DownloadTV is a tool that allows the user to find magnet links for tv show