my-local-putio 3.0.1 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8413c97f07692b12156692e884cc2dfde0c2c10a79faaa5c1e810355a6998bb
-  data.tar.gz: 1e53e68592413df77438216dd9d74595c1f9a84bdf4e3693a6ca1ef5346721be
+  metadata.gz: cbfff6a7128d63370560d6453a34a9f65cdc019c2cec8dfbaa42715ff776867e
+  data.tar.gz: e147047592191b5cfe4127a81f63ecdc5851baf660fd90a1d5eb3e1fa7c0d91b
 SHA512:
-  metadata.gz: '055585c0abc043d665fe56bc4f15eb0e047b4bfcb36b89eb34159fcea462ba5bc7269c0ad9fc94f3845132b5c70002280148c3c73a56a36c998d8ae387f89ed5'
-  data.tar.gz: 0736be82dee9501f1b2681191604600c4b747082c427d43701180c0028b51050af70ac1a08de1f8a065004a129361765d1910ff593bf2d9140c6389d2f9fde8d
+  metadata.gz: b3a239f681fcfde6f087c7782607e89b6cfef19eb6dd99781f986d85b75aed5ab91c96c6a74f42ea7db4ae40c3243ed20035270a5f3f2ce527c67f85970ff6b0
+  data.tar.gz: b5384e46713dd9e63bb09dd8156df491902077096b053d4bcc45df855c8e2ba251ea43c9f3bb651eafad7334a38615291ef34bbd48d5afe3f87de31aff59a98f

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# v4.0.0
+
+- Introducing with subtitles option
+- Breaking changes parameters
+  - removed -s option for --silent. Now silent is only available as --silent
+  - introduced -s option for --with-subtitles
+- More code refactoring
+
 # v3.0.1
 
 - Fix for delete-remote that was not enabling/disabling properly.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    my-local-putio (3.0.1)
+    my-local-putio (4.0.0)
       socksify (= 1.7.1)
 
 GEM

data/README.md

@@ -3,23 +3,17 @@ My Local Put.io [![Gem Version](https://badge.fury.io/rb/my-local-putio.svg)](ht
 
 The easiest script to synchronize all your [Put.io](http://put.io) files locally.
 
-For now the script only supports download the content from your account and keep it locally.
+After the download, you can enable the option to remove the files from Put.io and also download your preferred subtitles if available in Put.io.
 
 ### Features
 
-- Check and skip already downloaded files
-- Supports SOCKS5 proxy for an even more secure and anonymous transfer, with kill switch, so the application will stop if the proxy became unavailable. No leak connections.
+- Check and skip already downloaded files.
 - Resume broken/stopped downloads, so you don't have to start from the begin of your huge file.
-- Simple and easy to run
+- Supports SOCKS5 proxy for an even more secure and anonymous transfer, with kill switch, so the application will stop if the proxy became unavailable. No leak connections.
 - Option to delete the file from put.io after the download
-
-#### Planned features:
-
-- Option to download the subtitle if available in put.io list
-
-#### Future or ideas: (Feel free to contribute to the list)
-
-- Add a magnet/torrent to the put.io account based on local files or references.
+- Option to download your preferred subtitles from Put.io.
+- Simple and easy to run
+- For free and forever free :)
 
 ## Copyright Disclaimer
 
@@ -30,10 +24,14 @@ For now the script only supports download the content from your account and keep
 
 * Install ruby 2.6.0+
 * Generate a token for your put.io account: https://app.put.io/authenticate?client_id=1&response_type=oob
-* Install the `my-local-putio` gem:
+* Install the latest version of `my-local-putio` gem:
 
       gem install my-local-putio
 
+To update your installed version:
+
+      gem update my-local-putio
+
 ## Usage
 
     my-local-putio -h
@@ -42,8 +40,9 @@ For now the script only supports download the content from your account and keep
       -t, --token TOKEN                Put.io access token [REQUIRED]
       -l, --local-destination PATH     Local destination path [REQUIRED]
       -d, --delete-remote              Delete remote file/folder after the download
+      -s, --with-subtitles             Fetch subtitles from Put.io api
       -v, --version                    Print my-local-putio version
-      -s, --silent                     Hide all messages and progress bar
+          --silent                     Hide all messages and progress bar
           --debug                      Debug mode [Developer mode]
           --socks5-proxy hostname:port SOCKS5 hostname and port for proxy. Format: 127.0.0.1:1234
 
@@ -55,6 +54,7 @@ Examples:
 
     my-local-putio -t 123 -l Downloads
     my-local-putio -l Downloads --token 123
+    my-local-putio -l Downloads -t token123 -d -s --socks5-proxy 127.0.0.1:1234
 
 With Token variable (inline or exporting):
 
@@ -65,29 +65,31 @@ With Token variable (inline or exporting):
 
 #### Others attributes:
 * **-d** or **--delete-remote**: Delete the remote file/folder from put.io after downloading
+* **-s** or **--with-subtitles**: Download subtitles from Put.io API if available. (Remember to set your preferred subtitle language on Put.io Settings website, otherwise no subtitle will be available for download.)
 * **-h**: Print the help usage message
 * **-v** or **--version**: Print the version of the application
-* **-s** or **--silent**: Hide all messages and progress bar
+* **--silent**: Hide all messages and progress bar. Recommended for Cronjob tasks.
 * **--debug**: Developer mode: Prints everything and expose URLs with tokens for debug purposes.
 * **--socks5-proxy**: Enable the SOCKS5 proxy. If enabled, all the connections for PUT.IO API and the downloads will be performed using this proxy. If the socks connection became unavailable, the application will raise an error and will stop.
 
 Examples:
 
     my-local-putio -h
-    my-local-putio -t 123 -l Downloads --silent -d
-    my-local-putio -t 123 -l Downloads -s
-    my-local-putio --local-destination Downloads -t 123 --debug
+    my-local-putio -t 123 -l Downloads --silent -d -s
+    my-local-putio -t 123 -l Downloads --silent
+    my-local-putio --local-destination Downloads -t 123 --debug --with-subtitles
     my-local-putio --local-destination Downloads -t 123 --socks5-proxy 127.0.0.1:3333
 
 Verbose output example:
 
-    my-local-putio -t 123 -l Downloads -d --socks5-proxy 127.0.0.1:3333
+    my-local-putio -t 123 -l Downloads -d -s --socks5-proxy 127.0.0.1:3333
 
     Starting My Local Put.io - version 3.0.0
     https://github.com/rafaelbiriba/my-local-putio
     =============================================
     Full path of the local destination: /Users/user/Downloads
     >>> Delete remote files enabled!
+    >>> With subtitles enabled!
     >>> SOCKS5 enabled with 127.0.0.1:3333
     =============================================
     [LOG][2019-07-18 11:11:30] Getting file list for /

data/lib/my-local-putio.rb

@@ -24,6 +24,8 @@ require "my-local-putio/configuration"
 require "my-local-putio/logger"
 require "my-local-putio/putio_cli"
 require "my-local-putio/fetcher"
+require "my-local-putio/downloader"
+require "my-local-putio/subtitles_manager"
 
 module MyLocalPutio
   def self.print_introduction_msg(configuration)
@@ -33,6 +35,7 @@ module MyLocalPutio
     puts "============================================="
     puts "Full path of the local destination: #{File.realdirpath(configuration.local_destination)}"
     puts ">>> Delete remote files enabled!" if configuration.delete_remote
+    puts ">>> With subtitles enabled!" if configuration.with_subtitles
     puts ">>> SOCKS5 enabled with #{configuration.socks_host}:#{configuration.socks_port}" if configuration.socks_enabled?
     puts ">>> DEBUG enabled! Hello Mr(s) developer :)" if configuration.debug
     puts "============================================="

data/lib/my-local-putio/configuration.rb

@@ -1,6 +1,6 @@
 module MyLocalPutio
   class Configuration
-    attr_reader :token, :local_destination, :silent, :debug, :socks_host, :socks_port, :delete_remote
+    attr_reader :token, :local_destination, :silent, :debug, :socks_host, :socks_port, :delete_remote, :with_subtitles
     def initialize
       read_args_from_envs!
       parse_args!
@@ -21,12 +21,13 @@ module MyLocalPutio
         opt.on("-t", "--token TOKEN", "Put.io access token [REQUIRED]") { |v| @token = v }
         opt.on("-l", "--local-destination PATH", "Local destination path [REQUIRED]") { |v| @local_destination = v }
         opt.on("-d", "--delete-remote", "Delete remote file/folder after the download") { |v| @delete_remote = true }
+        opt.on("-s", "--with-subtitles", "Fetch subtitles from Put.io api") { |v| @with_subtitles = true }
         opt.on("-v", "--version", "Print my-local-putio version") do
           puts MyLocalPutio::VERSION
           exit
         end
 
-        opt.on("-s", "--silent", "Hide all messages and progress bar") { |v| @silent = true }
+        opt.on("--silent", "Hide all messages and progress bar") { |v| @silent = true }
         opt.on("--debug", "Debug mode [Developer mode]") { |v| @debug = true }
         opt.on("--socks5-proxy hostname:port", "SOCKS5 hostname and port for proxy. Format: 127.0.0.1:1234") do |v|
           @socks_host, @socks_port = v.to_s.split(":")

data/lib/my-local-putio/downloader.rb

@@ -0,0 +1,36 @@
+module MyLocalPutio
+  class Downloader
+    attr_reader :configuration, :logger
+
+    def initialize(configuration)
+      @configuration = configuration
+      @logger = configuration.logger
+    end
+
+    def download(url, path)
+      logger.debug "Download file from #{url}"
+      logger.log "Downloading: #{path}"
+      command = download_command(url, path)
+      fetch_result = system(*command)
+      raise "Unable to download #{path}" unless fetch_result
+    end
+
+    private
+
+    def download_command(url, path)
+      destination = File.join(configuration.local_destination, path)
+
+      command = [
+        "curl", "--create-dirs", "--progress-bar", "-L", "--retry", "5", "-S", "-C", "-", "-o", destination, url.to_s
+      ]
+
+      command.push("--silent") if logger.silent?
+
+      if configuration.socks_enabled?
+        command.push("--socks5-hostname", "#{configuration.socks_host}:#{configuration.socks_port}")
+      end
+
+      return command
+    end
+  end
+end

data/lib/my-local-putio/fetcher.rb

@@ -1,18 +1,19 @@
 module MyLocalPutio
   class Fetcher
-    attr_reader :configuration, :cli, :logger
+    attr_reader :configuration, :cli, :logger, :downloader
 
     def initialize(configuration)
       @configuration = configuration
       @logger = configuration.logger
       @cli = PutioCli.new(@configuration)
+      @downloader = Downloader.new(@configuration)
     end
 
     def run!
       fetch_files
     end
 
-    protected
+    private
 
     def fetch_files(id: nil, path: "/")
       logger.log "Getting remote file list for #{path}"
@@ -29,13 +30,15 @@ module MyLocalPutio
       if file.content_type == "application/x-directory"
         fetch_files(id: file.id, path: local_file_path)
       else
-        download(file, local_file_path) unless file_exists?(local_file_path, file)
-      delete_file(local_file_path, file) if configuration.delete_remote
+        url = cli.get_download_url(file.id)
+        Downloader.new(@configuration).download(url, local_file_path) unless file_exists?(local_file_path, file)
+        SubtitlesManager.new(configuration).fetch(file, path)
       end
       delete_file(local_file_path, file)
     end
 
     def delete_file(local_file_path, file)
+      return unless configuration.delete_remote
       logger.log "Deleting remote file: #{local_file_path}"
       cli.delete_file(file.id)
     end
@@ -45,29 +48,5 @@ module MyLocalPutio
       logger.log "File already downloaded #{local_file_path}" if file_exists
       file_exists
     end
-
-    def download_command(url, path)
-      destination = File.join(configuration.local_destination, path)
-
-      command = [
-        "curl", "--create-dirs", "--progress-bar", "-L", "--retry", "5", "-S", "-C", "-", "-o", destination, url.to_s
-      ]
-
-      command.push("--silent") if logger.silent?
-
-      if configuration.socks_enabled?
-        command.push("--socks5-hostname", "#{configuration.socks_host}:#{configuration.socks_port}")
-      end
-
-      return command
-    end
-
-    def download(file, path)
-      url = cli.get_download_url(file.id)
-      command = download_command(url, path)
-      logger.log "Downloading: #{path}"
-      fetch_result = system(*command)
-      raise "Unable to download #{path}" unless fetch_result
-    end
   end
 end

data/lib/my-local-putio/putio_cli.rb

@@ -20,10 +20,8 @@ module MyLocalPutio
       post("files/delete", args)
     end
 
-    def delete_file_url
-      url = to_url("files/delete")
-      url.query = URI.encode_www_form to_args()
-      url
+    def get_subtitles(id)
+      get("files/#{id}/subtitles")
     end
 
     def get_download_url(id)

data/lib/my-local-putio/subtitles_manager.rb

@@ -0,0 +1,45 @@
+module MyLocalPutio
+  class SubtitlesManager
+    attr_reader :configuration, :logger, :cli, :downloader
+
+    def initialize(configuration)
+      @configuration = configuration
+      @logger = configuration.logger
+      @cli = PutioCli.new(@configuration)
+      @downloader = Downloader.new(@configuration)
+    end
+
+    def fetch(file, path)
+      return unless configuration.with_subtitles
+      return unless file_is_video?(file)
+
+      local_subtitle_path = File.join(path, filename(file))
+      logger.log "Trying to fetch the preferred subtitle for: #{file.name}"
+      subtitles = cli.get_subtitles(file.id)["subtitles"]
+      if subtitles.empty?
+        logger.log ":( Could not find any preferred subtitle for: #{file.name}"
+        return
+      end
+
+      process_subtitle(subtitles, local_subtitle_path)
+    end
+
+    private
+    def filename(file)
+      File.basename(file.name, File.extname(file.name))
+    end
+
+    def file_is_video?(file)
+      file.file_type == "VIDEO"
+    end
+
+    def process_subtitle(subtitles, local_subtitle_path)
+      subtitles_grouped = subtitles.group_by{|k,v| k["language_code"]}
+      subtitles_grouped.each do |language_code, list|
+        path = local_subtitle_path + ".#{language_code}.srt"
+        logger.log("#{list.first["language"]} subtitle found!")
+        downloader.download(list.first["url"], path)
+      end
+    end
+  end
+end

data/lib/my-local-putio/version.rb

@@ -1,3 +1,3 @@
 module MyLocalPutio
-  VERSION = "3.0.1"
+  VERSION = "4.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: my-local-putio
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 4.0.0
 platform: ruby
 authors:
 - Rafael Biriba
@@ -70,9 +70,11 @@ files:
 - bin/my-local-putio
 - lib/my-local-putio.rb
 - lib/my-local-putio/configuration.rb
+- lib/my-local-putio/downloader.rb
 - lib/my-local-putio/fetcher.rb
 - lib/my-local-putio/logger.rb
 - lib/my-local-putio/putio_cli.rb
+- lib/my-local-putio/subtitles_manager.rb
 - lib/my-local-putio/version.rb
 - my-local-putio.gemspec
 homepage: https://github.com/rafaelbiriba/my-local-putio