download_tv 2.1.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 358854a4a50e549541b64dfa8e3279998a3c7a12
-  data.tar.gz: 643f9a41e0c91866228469a26371c35cfda7be82
+  metadata.gz: 01776f973e2d3bab1f88189cbf4315fc0f33923e
+  data.tar.gz: bf5057e5fbda8bb6724dd69f9d3633abe2fc2f98
 SHA512:
-  metadata.gz: f5ae32db31ab5bd149b5c8d1165142b61a7a2df3b41d91c96e9cbbe31f8846333de4b9a5d01b6b34f7f162c68623d0382b7e94dd55e6e1a20a239fa486bbac4d
-  data.tar.gz: 8b6423716c1bc322aed18bb778160cc5bd1a618a31cfcd3a984f788959c76009f7db80d78c44bf548a25646149f493476a2f16bdbf5e23410356902812457989
+  metadata.gz: d6dc22d8625510cf9f1a6aac9198d6f95d6bb4953fd43e175f6ec09b3a397a3ed28239bcc20ff2dd1025cdbe83e20fbc0930febaf42a190e93758c6e1687910a
+  data.tar.gz: b60c1b8b52b9c74a1328afb6da8ee3011eb975d187553c5b4f947fce6c07d3c228aa45e45202be21f38f6a3d491b7e24da88980b8136052388ec78b3ba6b3a66

data/.gitignore

@@ -1,5 +1,2 @@
-date
-config
-cookie
 /Gemfile.lock
 /pkg/

data/README.md

@@ -4,7 +4,7 @@
 [![Gem Version](https://badge.fury.io/rb/download_tv.svg)](https://badge.fury.io/rb/download_tv)
 [![Code Climate](https://codeclimate.com/github/guille/download_tv.svg)](https://codeclimate.com/github/guille/download_tv)
 
-download_tv is a Ruby command line application that automatically downloads the new episodes from the shows you follow. It grabs the list of shows from your MyEpisodes account.
+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
 
@@ -33,12 +33,20 @@ Specific options:
 
 ```
 
-Four actions are recognised:
+### Examples
 
-* By default, it fetches the list of episodes from MyEpisodes that have aired since the program was run for the last time and tries to download them. The -o flag can be used in order to re-download the episodes from previous days.
+By default, it fetches the list of episodes from MyEpisodes.com that have aired since the program was run for the last time and tries to download them. 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)
 
-* In order to download a single episode, use the -d flag. Example: *tv -d Breaking Bad S04E01*
+In order to download a single episode, use the -d flag: *tv -d Breaking Bad S04E01*
 
-* he -f flag can be used to download a set of episodes. This option takes a text file as an argument. Each line of the file is interpreted as a episode to download. Example: *tv -f /path/to/listofeps*
+The -f flag can be used to read the list of episodes to download from a file. Each line of the file is interpreted as a episode to download: *tv -f /path/to/listofeps*
 
-* Finally, with -c you can edit your configuration defaults (your MyEpisodes user, whether to save the auth cookie or the shows you wish to ignore)
+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.
+
+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).
+
+With -g and --show-grabbers, the user can see what grabbers are available and choose one of these as their preferred option. By default, the application searchs for torrents in TorrentAPI, ThePirateBay, KAT and EZTV, in that order, skipping to the next when one of them is down/doesn't have a torrent for said episode.
+
+### 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/download_tv.gemspec

@@ -30,6 +30,8 @@ Gem::Specification.new do |s|
   s.add_dependency("mechanize")
   s.add_dependency("date")
   s.add_dependency("io-console")
+  s.add_dependency("fileutils")
 
   s.has_rdoc    = false
+  s.license     = "MIT"
 end

data/lib/download_tv/configuration.rb

@@ -3,13 +3,13 @@ module DownloadTV
 		attr_reader :content, :config_path
 		
 		def initialize(content={}, force_change=false)
-			Dir.chdir(__dir__)
-
-			@config_path = content[:path] || "config"
+			FileUtils.mkdir_p(File.join(ENV["HOME"], ".config", "download_tv"))
+			@config_path = content[:path] || File.join(ENV["HOME"], ".config", "download_tv", "config")
 			
 			if File.exist? @config_path
-				@content = File.open(@config_path, "rb") { |f| Marshal.load(f) }
+				load_config
 				@content.merge!(content) unless content.empty?
+				@content[:ignored]&.map!(&:downcase)
 				change_configuration if force_change
 			else
 				@content = content
@@ -43,14 +43,31 @@ module DownloadTV
 			@content[:auto] ||= true
 			@content[:subs] ||= true
 			@content[:grabber] ||= "TorrentAPI"
+			@content[:date] ||= Date.today-1
+			@content[:version] = DownloadTV::VERSION
 
-			serialize()
+			serialize
 		end
 
 
 		def serialize
 			File.open(@config_path, "wb") { |f| Marshal.dump(@content, f) }
 		end
+
+		def load_config
+			@content = File.open(@config_path, "rb") { |f| Marshal.load(f) }
+			if !@content[:version] || breaking_changes?(@content[:version])
+				change_configuration
+			end
+		end
+
+		##
+		# Returns true if a major or minor update has been detected
+		# Returns false if a patch has been detected
+		# Returns nil if it's the same version
+		def breaking_changes?(version)
+			DownloadTV::VERSION.split(".").zip(version.split(".")).find_index { |x, y| y > x }&.< 2
+		end
 		
 
 		def print_config

data/lib/download_tv/downloader.rb

@@ -43,7 +43,7 @@ module DownloadTV
 		##
 		# Finds download links for all new episodes aired since the last run of the program
 		# It connects to MyEpisodes in order to find which shows to track and which new episodes aired.
-		def run(dont_write_to_date_file)
+		def run(dont_update_last_run)
 			date = check_date
 
 			myepisodes = MyEpisodes.new(@config[:myepisodes_user], @config[:cookie])
@@ -86,7 +86,7 @@ module DownloadTV
 				puts "Completed. Exiting..."
 			end
 
-			File.write("date", Date.today) unless dont_write_to_date_file
+			@config[:date] = Date.today unless dont_update_last_run
 
 		rescue InvalidLoginError
 			warn "Wrong username/password combination"
@@ -128,19 +128,13 @@ module DownloadTV
 
 
 		def check_date
-			content = File.read("date")
-			
-			last = Date.parse(content)
+			last = @config[:date]
 			if last - @offset != Date.today
 				last - @offset
 			else
 				puts "Everything up to date"
 				exit
 			end
-			
-		rescue Errno::ENOENT
-			File.write("date", Date.today-1)
-			retry
 		end
 
 

data/lib/download_tv/myepisodes.rb

@@ -6,6 +6,7 @@ module DownloadTV
 			@agent = Mechanize.new
 			@user = user
 			@save_cookie = save_cookie
+			@cookie_path = File.join(ENV["HOME"], ".config", "download_tv", "cookie")
 		end
 
 		def login
@@ -35,8 +36,8 @@ module DownloadTV
 		end
 
 		def load_cookie
-			if File.exist? "cookie"
-				@agent.cookie_jar.load "cookie"
+			if File.exist? @cookie_path
+				@agent.cookie_jar.load @cookie_path
 				page = @agent.get "https://www.myepisodes.com/login.php"
 				if page.links[1].text == "Register"
 					puts "The cookie is invalid/has expired."
@@ -51,7 +52,7 @@ module DownloadTV
 		end
 
 		def save_cookie
-			@agent.cookie_jar.save("cookie", session: true)
+			@agent.cookie_jar.save(@cookie_path, session: true)
 			@agent
 			
 		end

data/lib/download_tv/version.rb

@@ -1,3 +1,3 @@
 module DownloadTV
-  VERSION = "2.1.1"
+  VERSION = "2.2.0"
 end

data/test/config_test.rb

@@ -16,37 +16,157 @@ describe DownloadTV::Configuration do
 			create_dummy_config(config_path)
 
 			c = DownloadTV::Configuration.new(path: config_path)
-			c.content.must_equal ({path: config_path})
+			c.content.must_equal ({path: config_path, version: DownloadTV::VERSION})
 		end
 
 		it "will load the existing configuration (existing)" do
 			create_dummy_config(config_path, auto: false, myepisodes_user: "dummy")
 
 			c = DownloadTV::Configuration.new(path: config_path)
-			c.content.must_equal ({path: config_path, auto: false, myepisodes_user: "dummy"})
+			c.content.must_equal ({path: config_path, auto: false, myepisodes_user: "dummy", version: DownloadTV::VERSION})
 		end
 
 		it "will get overwritten by the parameters given" do
 			create_dummy_config(config_path, myepisodes_user: "dummy")
 
 			c = DownloadTV::Configuration.new(path: config_path, myepisodes_user: "fake")
-			c.content.must_equal ({path: config_path, myepisodes_user: "fake"})
+			c.content.must_equal ({path: config_path, myepisodes_user: "fake", version: DownloadTV::VERSION})
+		end
+
+		it "will downcase ignored shows" do
+			create_dummy_config(config_path, ignored: ["duMMy", "String"])
+
+			c = DownloadTV::Configuration.new(path: config_path)
+			c.content[:ignored].must_equal ["dummy", "string"]
+		end
+	end
+
+	describe "the breaking_changes method" do
+		it "returns nil when both versions are equal" do
+			create_dummy_config(config_path)
+
+			c = DownloadTV::Configuration.new(path: config_path)
+			c.breaking_changes?(DownloadTV::VERSION).must_be_nil
+		end
+
+		it "returns true when there's been a major update" do
+			create_dummy_config(config_path)
+
+			split = DownloadTV::VERSION.split(".")
+			split[0] = (split[0].to_i+1).to_s
+			new_version = split.join(".")
+			c = DownloadTV::Configuration.new(path: config_path)
+			c.breaking_changes?(new_version).must_equal true
+		end
+
+		it "returns true when there's been a minor update" do
+			create_dummy_config(config_path)
+
+			split = DownloadTV::VERSION.split(".")
+			split[1] = (split[1].to_i+1).to_s
+			new_version = split.join(".")
+			c = DownloadTV::Configuration.new(path: config_path)
+			c.breaking_changes?(new_version).must_equal true
+		end
+
+		it "returns false when it's a small patch" do
+			create_dummy_config(config_path)
+
+			split = DownloadTV::VERSION.split(".")
+			split[2] = (split[2].to_i+1).to_s
+			new_version = split.join(".")
+			c = DownloadTV::Configuration.new(path: config_path)
+			c.breaking_changes?(new_version).must_equal false
+		end
+	end
+
+	describe "when the file doesn't exist" do
+		it "will create a new one" do
+			run_silently do
+				STDIN.stub :gets, "myepisodes\ncookie\nignored" do
+					DownloadTV::Configuration.new(path: config_path)
+				end
+			end
+
+			File.exist?(config_path).must_equal true
+		end
+
+		it "will have the right values" do
+			c = nil
+			run_silently do
+				STDIN.stub :gets, "anything" do
+					c = DownloadTV::Configuration.new(path: config_path)
+				end
+			end
+
+			c.content[:myepisodes_user].must_equal "anything"
+			c.content[:cookie].must_equal true
+			c.content[:ignored].must_equal ["anything"]
+			c.content[:auto].must_equal true
+			c.content[:subs].must_equal true
+			c.content[:grabber].must_equal "TorrentAPI"
+			c.content[:date].must_equal Date.today-1
+			c.content[:version].must_equal DownloadTV::VERSION
+
+		end
+
+		it "will set the cookie value to false when explicitly told so" do
+			c = nil
+			run_silently do
+				STDIN.stub :gets, "n" do
+					c = DownloadTV::Configuration.new(path: config_path)
+				end
+			end
+
+			c.content[:cookie].must_equal false
+		end
+
+		it "will separate the ignored values by commas" do
+			c = nil
+			run_silently do
+				STDIN.stub :gets, "ignored1, itsgone, ignored 2" do
+					c = DownloadTV::Configuration.new(path: config_path)
+				end
+			end
+			c.content[:ignored].must_equal ["ignored1", "itsgone", "ignored 2"]
 		end
 	end
 
-	# describe "when the file doesn't exist" do
-	# 	it "will create a new one" do
-	# 		# Send stuff to stdin
-	# 		flunk
-	# 		DownloadTV::Configuration.new(path: config_path)
-	# 		File.exist?(config_path).must_equal true			
-	# 	end
+	describe "the serialize method" do
+		it "stores the configuration in a Marshal'd file" do
+			# Calls serialize
+			run_silently do
+				STDIN.stub :gets, "anything" do
+					DownloadTV::Configuration.new(path: config_path)
+				end
+			end
+			content = File.open(config_path, "rb") { |f| Marshal.load(f) }
 
-	# 	it "will trigger a configuration change when asked to" do
-	# 		DownloadTV::Configuration.new(path: config_path, true)
-	# 	end
-	# end
+			content[:cookie].must_equal true
+			content[:myepisodes_user].must_equal "anything"
+			content[:ignored].must_equal ["anything"]
+			content[:auto].must_equal true
+			content[:subs].must_equal true
+			content[:grabber].must_equal "TorrentAPI"
+			content[:date].must_equal Date.today-1
+			content[:version].must_equal DownloadTV::VERSION
+		end
+	end
+
+	describe "the constructor" do
+		it "will trigger a configuration change when asked to" do
+			create_dummy_config(config_path, auto: false)
+			File.exist?(config_path).must_equal true
+			c = nil
+
+			run_silently do
+				STDIN.stub :gets, "anything" do
+					c = DownloadTV::Configuration.new(path: config_path)
+				end
+			end
 
-	# test [:ignored] gets turned to lowercase
+			c.content[:auto].must_equal false
+		end
+	end
 
 end

data/test/downloader_test.rb

@@ -5,7 +5,6 @@ describe DownloadTV::Downloader do
 
 	before do
 		Dir.chdir(__dir__)
-		File.delete("date") if File.exist?("date")
 		create_dummy_config(config_path) unless File.exist?(config_path)
 	end
 
@@ -44,35 +43,17 @@ describe DownloadTV::Downloader do
 			shows = ["Mr. Foo S01E02", "Bar (UK) S00E22", "Ignored S20E22", "Let's S05E03"]
 			result = ["Mr. Foo S01E02", "Bar S00E22", "Lets S05E03"]
 			
-			dl = DownloadTV::Downloader.new(0, ignored: ["Ignored"], path: config_path)
+			dl = DownloadTV::Downloader.new(0, ignored: ["ignored"], path: config_path)
 			dl.fix_names(shows).must_equal result
 		end
 	end
 
 
-	describe "the date file" do 
-
-		it "should be created if it doesn't exist" do
-			dl = DownloadTV::Downloader.new(0, path: config_path)
-			Dir.chdir(__dir__) # Use date file in test directory
-			dl.check_date
-			File.exist?("date").must_equal true
-		end
-
-		it "contains a date after running the method" do
-			dl = DownloadTV::Downloader.new(0, path: config_path)
-			Dir.chdir(__dir__)
-			date = dl.check_date
-			date.must_equal (Date.today-1)
-			Date.parse(File.read("date")).must_equal Date.today-1
-		end
-
+	describe "the check_date method" do
 		it "exits the script when up to date" do
-			File.write("date", Date.today)
 			begin
-				dl = DownloadTV::Downloader.new(0, path: config_path)
-				Dir.chdir(__dir__)
-				dl.check_date
+				dl = DownloadTV::Downloader.new(0, date: Date.today, path: config_path)
+				run_silently { dl.check_date }
 				flunk
 			rescue SystemExit
 			
@@ -80,16 +61,13 @@ describe DownloadTV::Downloader do
 		end
 
 		it "uses the offset to adjust the date" do
-			File.write("date", Date.today)
-
 			# Would exit with offset 0
-			dl = DownloadTV::Downloader.new(1, path: config_path)
+			dl = DownloadTV::Downloader.new(1, date: Date.today, path: config_path)
 
-			Dir.chdir(__dir__)
 			date = dl.check_date
 
 			date.must_equal (Date.today-1)
-			Date.parse(File.read("date")).must_equal Date.today
+			dl.config[:date].must_equal Date.today
 		end
 		
 	end

data/test/test_helper.rb

@@ -5,5 +5,14 @@ require "minitest/autorun"
 
 
 def create_dummy_config(in_path, config={})
+	config[:version] = DownloadTV::VERSION if !config[:version]
 	File.open(in_path, "wb") { |f| Marshal.dump(config, f) }
+end
+
+def run_silently
+	previous_stdout, $stdout = $stdout, StringIO.new
+	yield
+	$stdout.string
+ensure
+	$stdout = previous_stdout
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: download_tv
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.0
 platform: ruby
 authors:
 - guille
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-31 00:00:00.000000000 Z
+date: 2017-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: fileutils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - guillerg96@gmail.com
@@ -142,7 +156,8 @@ files:
 - test/test_helper.rb
 - test/torrent_test.rb
 homepage: https://github.com/guille/download_tv
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []