subfinder 0.0.2.4 → 0.0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 491dbbfa5744087587e018ebce5fe4bfa022d16f393b0f8011c32dc4e1aae0ac
-  data.tar.gz: 664aa2629ff27e846c2f38fd2045f89dc2a9f1ca9b965cbbaf9a9e52c1bd5f35
+  metadata.gz: 5b5c0c954cb1ef5d74e2de7e5112290116330a58264932c14f4dd55ffcf34bd0
+  data.tar.gz: 1ff9be3de677d9060d027823525bb4d06d80a40e070629fe32f374b6baf05bbe
 SHA512:
-  metadata.gz: 64ae660718fda1bf21e8dedbcedc6166e3533150ad65d7059978d6ad2526323ed8a5debb33b58f390eed4aaedfafee25da09f3a11b663064800d531318fe9096
-  data.tar.gz: b902c1a019c08e80cc1fb2572c4e9646a523be3ba5826a5d66f128ba54f9d6e765c335879eee53537d3b2e59e79d096c29248d9924cf841582cf242c39bdc505
+  metadata.gz: ecdab554e2d3c5f0bcbb36b41fbbb51dff9d047084f0d82a0332591b77d6a9996716643db6d6f76443e83e194594853cee95ec1b05c6a6c2013dcd2e4032bac3
+  data.tar.gz: 1ebe24da29c9b1628e124ddb9cbbb66a5af5bdb0ae2732220d22d1ad16f487e10a201080dd678b99cefd4aa86f73a48e1ef2eaf1ce6099d6a4573372b0bce8ea

data/.circleci/config.yml

@@ -35,7 +35,8 @@ jobs:
       - run:
           name: install dependencies
           command: |
-            bundle install --jobs=4 --retry=3 --path vendor/bundle
+            #bundle install --jobs=4 --retry=3 --path vendor/bundle
+            bundle install --jobs=4 --retry=3
 
       - save_cache:
           paths:
@@ -51,7 +52,7 @@ jobs:
           name: run tests
           command: |
             mkdir /tmp/test-results
-            rake test
+            rake test --trace
 
       # collect reports
       - store_test_results:

data/.gitignore

@@ -7,3 +7,5 @@
 /spec/reports/
 /tmp/
 .DS*
+*.swp
+/dryrun_test_directory/

data/Gemfile

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
-ruby "2.5.1"
+ruby '2.5.1'
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in subfinder.gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    subfinder (0.0.2.3)
+    subfinder (0.0.2.4)
       bundler (~> 2.0.1)
       colorize (~> 0.8)
       nokogiri (~> 1.10.1)
@@ -54,7 +54,6 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  colorize (~> 0.8)
   minitest (~> 5.0)
   subfinder!
   test-unit (~> 3.1.8)

data/README.md

@@ -10,26 +10,19 @@ You have a TV series without subtitles. Open the terminal, go to the folder wher
 
 It works fine with the video file names which followed `S01E01` naming format.
 
-## Installation
 
-  
+## Installation  
 
 First you need to have `Ruby` and `Gem` on your machine.
 
-  
-
 Then simply run:
 
-  
-
 `$ gem install subfinder`
 
 Without any switches, this will unzip all zipped or compressed files and find/rename them to correspondent video file. Also you can provide the URL for `subscene.com` list page with `-u` and it would download the correct file and do the rest.
 
-## Usage
-
 
-  
+## Usage  
 
 `$ subfinder -u https://subscene.com/subtitles/the-kominsky-method -l fa`
 
@@ -37,69 +30,31 @@ Without any switches, this will unzip all zipped or compressed files and find/re
 
 - Use `-u` or `--url` to specify a URL page of a TV series on `subscene.com` website.
 
-- Also see `sunfinder -h` for help
+- Run `subfinder --dryrun` to create set of mock files on you current directory and running Subfinder.
 
-  
+- Also see `sunfinder -h` for help  
   
 
+
 ## Development
 
 * Please report any broken thing using Github issues *
 
 To run tests, run `rake test`.
 
-
-To see all logs, run with `-d` or `--degub`
-  
+To see all logs, run with `-d` or `--degub`  
 
 Clone the project. Make changes and then `rake build` inside the project folder to create Gem.
 
 Then `gem install pkg/subfinder-0.0.1.gem` to install it locally.
 
-Create a temp folder and run `movies_list_creator.rb` inside that folder. It will create fake files.
-
-  
-  
 
 ## License
 
-  
-
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
-  
-  
 
 # TODO
 
-- [x] get sub title language
-
-- [x] extract all files
-
-- [x] list all files
-
-- [x] match srt for each video file
-
-- [x] rename all matches
-
-- [x] move all other files to extract folder
-
-- [x] if not available then find it online test
-
-- [x] if not available then find it online code
-
-- [x] if language sub is not available then find English
-
-- [x] download match subtitle
-
-- [x] check for internet connectivity or issue for accessing blocked websites
-
-- [ ] add all language codes
-
-- [ ] move all other files from sub folders to main folder when extracting
-
-- [ ] add messages for timeout on web browsing
-
-- [ ] save user entered config for later use
+- Add all language codes
 
-- [ ] Writing article about it (VCR)

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rake/testtask'
 

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'subfinder'

data/bin/subfinder

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 require 'bundler/setup'
 require_relative '../lib/subfinder'
 

data/lib/subfinder.rb

@@ -1,14 +1,18 @@
+# frozen_string_literal: true
+
 require 'json'
 require 'colorize'
 require 'logger'
 require 'optparse'
 require 'zip'
+require 'rest-client'
 
 require_relative 'subfinder/version'
 require_relative 'subfinder/subtitle'
 require_relative 'subfinder/config'
 require_relative 'subfinder/main'
 require_relative 'subfinder/logger'
+require_relative 'subfinder/dryrun'
 
 require_relative 'subfinder/parser/args'
 require_relative 'subfinder/parser/files'

data/lib/subfinder/config.rb

@@ -1,8 +1,13 @@
+# frozen_string_literal: true
+
 module Subfinder
+  # Configuration for different running modes
   class Config
     @video_formats = %w[.avi .mp4 .mkv]
     class << self
-      attr_accessor :subtitles, :language, :url, :working_dir, :video_formats, :debug
+      attr_accessor :subtitles, :language, :url,
+                    :working_dir, :video_formats, :debug,
+                    :quiet
     end
   end
 end

data/lib/subfinder/dryrun.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Subfinder
+  # Would create a folder, create fake files and run Subfinder
+  class Dryrun
+    class << self
+      def enable
+        Logger.info 'Runnign in Dryrun mode.'
+        dryrun_dir = Dir.pwd + '/dryrun_test_directory'
+        Dir.mkdir(dryrun_dir)
+        Config.working_dir = dryrun_dir
+        create_mock_files_in dryrun_dir
+      end
+
+      def mock_list_file
+        # files with different subtitle file names
+        files = video_subtitle_pairs
+
+        # Files with space in their names
+        files += ['The Mechanism S01E06 - The Silkworm pt1 x264 RB58.mp4',
+                  'The Mechanism S01E06.pilot.720p BluRay BRRip 480p'\
+                  ' BoB-edited version.srt']
+
+        # Dingle file without subtutles
+        files + %w[The.Mechanism.S02E03.1080p.HDTV.x264.mp4]
+      end
+
+      def video_subtitle_pairs
+        %w(
+          Mechanism.The.S01E01.1080p.5.1Ch.BluRay.ReEnc-DeeJayAhmed.mkv
+          The.Mechanism.S01E02.HDTV.x264-SVA[eztv].mkv
+          The.Mechanism.S01E03.1080p.HDTV.x264.mp4
+          The.Mechanism.S01E04.720p.WEB-DL.DibaMoviez.mkv
+          Agatha.Christies.Poirot.S13E02.1080p.BluRay.x264.mkv
+          The.Mechanism.S01E01.WEB-DL.srt
+          The.Mechanism.S01E02.HDTV.x264-SVA.srt
+          The.Mechanism.S01E03.720p.HDTV.x264-IMMERSE.srt
+          The.Mechanism.S01E04.HDTV.x264.KILLERS.HI.srx.srt
+          The.Mechanism.S01E05.720p.WEB.H264-MEMENTO.srt
+        )
+      end
+
+      def create_mock_files_in(folder)
+        mock_list_file.each do |file_name|
+          File.open(folder + '/' + file_name, 'w') do |f|
+            f.write('this is sample file')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/subfinder/logger.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 module Subfinder
+  # Logger class, shoud initiate at the start of the program
   class Logger < ::Logger
     class << self
       def setting
@@ -11,7 +14,7 @@ module Subfinder
       end
 
       def info(str)
-        @logger.info(str)
+        @logger.info(str) unless Config.quiet
       end
 
       def debug(str)

data/lib/subfinder/main.rb

@@ -1,10 +1,13 @@
+# frozen_string_literal: true
+
 module Subfinder
+  # Initialize config and then search and match subtitles
   class Main
     class << self
       def run(args)
-        Subfinder::Logger.setting
-        Subfinder::Parser::Args.new args
-        Subfinder::Subtitle.new.match
+        Logger.setting
+        Parser::Args.new args
+        Subtitle.new.match
       end
     end
   end

data/lib/subfinder/parser/args.rb

@@ -1,10 +1,13 @@
+# frozen_string_literal: true
+
 module Subfinder
   module Parser
     class Args
+      # Initialze and parse input args
       def initialize(args)
         @args = args
         parse_args
-        validate_required_args
+        set_default_values
       end
 
       def parse_args
@@ -12,27 +15,30 @@ module Subfinder
         opts.banner = usage_msg
         opts.separator ''
         opts.separator 'options:'
-        opts.on('-u', '--url url', 'Set subscene url page') { |url| Config.url = url }
+        opts.on('-u', '--url url', 'Set Subscene url page') { |url| Config.url = url }
         opts.on('-l', '--language language', 'Set subtitle language') { |language| Config.language = language }
-        opts.on('-v', '--version', 'Show the Compare Crypto version') { puts("Subfinder #{Subfinder::VERSION}"); exit }
-        opts.on('-h', '--help', 'Show this message') { puts(opts); exit }
-        opts.on('-d', '--debug', 'debug') { Config.debug = true }
+        opts.on('-v', '--version', 'Show the Subfinder version') { puts("Subfinder #{Subfinder::VERSION}"); exit }
+        opts.on('-h', '--help', 'You used it just now') { puts(opts); exit }
+        opts.on('-d', '--debug', 'Run in debug mode') { Config.debug = true }
+        opts.on('-q', '--quiet', 'Display no message') { Config.quiet = true }
+        opts.on('--dryrun', 'Test application on mock files') { Subfinder::Dryrun.enable }
 
         opts.parse!(@args)
       end
 
       private
 
-      def validate_required_args
+      def set_default_values
+        # Set English as a default value for subtitle language if not provided
         Config.language ||= 'en'
-        Config.working_dir = Dir.pwd
+        Config.working_dir ||= Dir.pwd
       end
 
       def usage_msg
         usage = '
           Usage:
             subfinder [options]
-            See https://github.com/sizief/subfinder for more information. 
+            See https://github.com/sizief/subfinder for more information.
         '
         usage
       end

data/lib/subfinder/parser/download.rb

@@ -1,7 +1,8 @@
-require 'rest-client'
+# frozen_string_literal: true
 
 module Subfinder
   module Parser
+    # Download subtitle files from Internet
     class Download
       def initialize(url)
         @url = url
@@ -9,7 +10,7 @@ module Subfinder
 
       def save
         res = RestClient.get @url
-        return false unless  @url =~ URI::regexp
+        return false unless  @url =~ URI::DEFAULT_PARSER.make_regexp
         return false unless response_is_healthy? res
 
         file_name = res.headers[:content_disposition].split('=')[1]
@@ -23,11 +24,11 @@ module Subfinder
 
       def response_is_healthy?(res)
         if res.code != 200
-          Logger.info "Error when downloading '#{@url}'\n Error message: resposnse code is #{res.code}\n".red
-          false
+          Logger.info "Error when downloading '#{@url}'\n resposnse code: #{res.code}\n".red
+          return false
         elsif res.body.include? 'An error occurred while processing your request.'
-          Logger.info "Error when downloading '#{@url}'\n Error message:  'An error occurred while processing your request.'\n".red
-          false
+          Logger.info "Error downloading '#{@url}'. Try Again in few seconds".red
+          return false
         else
           true
         end

data/lib/subfinder/parser/files.rb

@@ -1,15 +1,20 @@
+# frozen_string_literal: true
+
 module Subfinder
   module Parser
+    # All file and folder related actions
     class Files
       class << self
         def list
           prepare_file_list
-          Dir["#{Config.working_dir}/*"]
+          Dir["#{pwd}/*"]
         end
 
         def prepare_file_list
-          files = Dir["#{Config.working_dir}/*"]
-          compressed_files = files.select { |file| ['.zip', '.rar'].include? File.extname(file) }
+          files = Dir["#{pwd}/*"]
+          compressed_files = files.select do |file|
+            ['.zip', '.rar'].include? File.extname(file)
+          end
           extract_all compressed_files
           move_compressed_files compressed_files
         end
@@ -18,7 +23,7 @@ module Subfinder
           array_list.each do |file|
             Zip::File.open(file) do |zip_file|
               zip_file.each do |entry|
-                file_path = Config.working_dir + '/' + entry.name
+                file_path = pwd + '/' + entry.name
                 unless File.exist? file_path
                   Logger.info "Extracting #{entry.name}"
                   entry.extract(file_path)
@@ -29,11 +34,17 @@ module Subfinder
         end
 
         def move_compressed_files(compressed_files)
-          unless compressed_files.empty?
-            Dir.mkdir(Config.working_dir + '/compressed') unless File.exist?(Config.working_dir + '/compressed')
-            compressed_files.each { |f| File.rename(f, File.dirname(f) + '/compressed/' + File.basename(f)) }
+          return if compressed_files.empty?
+
+          Dir.mkdir("#{pwd}/compressed") unless File.exist?("#{pwd}/compressed")
+          compressed_files.each do |f|
+            File.rename(f, File.dirname(f) + '/compressed/' + File.basename(f))
           end
         end
+
+        def pwd
+          Config.working_dir
+        end
       end
     end
   end