my-local-putio 2.1.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ebd963a16897bd822f3d645dc96c195ed9c2ab6e0d10c7e3105e8f5f1c9a31bb
-  data.tar.gz: 20504d68d91dee34108c6b3f57253d1a522b25be9c250935459727c5b218ccdb
+  metadata.gz: d9926010a7296b64e53e36469ca62e01f01e765b1fc8efdcab2681f45c0bc370
+  data.tar.gz: f8235be041d1639f3cc0e5b63fe8ffce9d4755cd1678250d43728763e608c5c6
 SHA512:
-  metadata.gz: 320d88bcf89dc9e86ac7f0ce7822148b5599424c5177ac9033cfea2efb2016d2e5740d7e693b968deddb2da68ae18ab5c7497a9b17af407222c37e45e9e1461e
-  data.tar.gz: 2651b2609fd2943ac205d81eeead93662b28a3b0072873649d2cb95b5afa9b4471a41eb2455710ecf4b8875c621eed05e2e3eaa32d127461c2d27ce5ec27ae53
+  metadata.gz: b3325310547f3350073771a381ab300facf64e3a54af83e3494be7078a924eb8975e8f34aedd6f1f7a98bc07145e121ed20eebf26ff4e5d59ac701b2faa8544f
+  data.tar.gz: 82debad28c46401a321d8c6d2dadfa56a0b2beda08c905ce5aa7657552977f05eac488c4fe5cbc47e1fb3191b1ac93e0f2db31d907fd4985bd8ae4d5382d5e72

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# v3.0.0
+
+- Introducing delete from remote after downloading
+- Breaking changes parameters
+  - removed -d option for --debug. Now debug is only available as --debug
+  - introduced -d option for --delete-remote
+- More code refactoring
+
 # v2.1.0
 
 - Introducing SOCKS5 support with `--socks5-proxy` option.

data/Gemfile.lock

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

data/README.md

@@ -11,10 +11,10 @@ For now the script only supports download the content from your account and keep
 - 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.
 - Resume broken/stopped downloads, so you don't have to start from the begin of your huge file.
 - Simple and easy to run
+- Option to delete the file from put.io after the download
 
 #### Planned features:
 
-- Option to delete the file on put.io after sync
 - Option to download the subtitle if available in put.io list
 
 #### Future or ideas: (Feel free to contribute to the list)
@@ -39,12 +39,13 @@ For now the script only supports download the content from your account and keep
     my-local-putio -h
 
     Usage: my-local-putio [options]
-        -t, --token TOKEN                Put.io access token [REQUIRED]
-        -l, --local-destination PATH     Local destination path [REQUIRED]
-        -v, --version                    Print my-local-putio version
-        -s, --silent                     Hide all messages and progress bar
-        -d, --debug                      Debug mode [Developer mode]
-        --socks5-proxy hostname:port SOCKS5 hostname and port for proxy. Format: 127.0.0.1:1234
+      -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
+      -v, --version                    Print my-local-putio version
+      -s, --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
 
 #### Required attributes:
 * **-t** or **--token**: Your Put.io Token. This attribute becames optional if you set `PUTIO_TOKEN` env variable with your token (Can be inline or into your bash profile). Check examples below.
@@ -63,26 +64,37 @@ With Token variable (inline or exporting):
       my-local-putio --local-destination Downloads/
 
 #### Others attributes:
+* **-d** or **--delete-remote**: Delete the remote file/folder from put.io after downloading
 * **-h**: Print the help usage message
 * **-v** or **--version**: Print the version of the application
 * **-s** or **--silent**: Hide all messages and progress bar
-* **-d** or **--debug**: Developer mode: Prints everything and expose URLs with tokens for debug purposes.
+* **--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
+    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 --local-destination Downloads -t 123 --socks5-proxy 127.0.0.1:3333
 
 Verbose output example:
 
-    [LOG][2019-07-18 11:11:30] Getting files for Downloads
-    [LOG][2019-07-18 11:11:31] Getting files for Downloads/ubuntu-18.04.2-desktop-amd64.iso
-    [LOG][2019-07-18 11:11:31] Downloading: Downloads/ubuntu-18.04.2-desktop-amd64.iso
+    my-local-putio -t 123 -l Downloads -d --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!
+    >>> SOCKS5 enabled with 127.0.0.1:3333
+    =============================================
+    [LOG][2019-07-18 11:11:30] Getting file list for /
+    [LOG][2019-07-18 11:11:31] Getting file list for /ubuntu
+    [LOG][2019-07-18 11:11:31] Downloading: /ubuntu/ubuntu-18.04.2-desktop-amd64.iso
     ######################################################################## 100.0%
+    [LOG][2019-07-18 11:11:33] Deleting remote file: /ubuntu/ubuntu-18.04.2-desktop-amd64.iso
 
 #### Troubleshooting
 

data/bin/my-local-putio

@@ -9,6 +9,5 @@ unless open(__FILE__).flock(File::LOCK_EX | File::LOCK_NB)
 end
 
 configuration = MyLocalPutio::Configuration.new
-logger = MyLocalPutio::Logger.new(configuration)
-putio_cli = MyLocalPutio::PutioCli.new(configuration, logger)
-MyLocalPutio::Fetcher.new(configuration, putio_cli, logger).run!
+MyLocalPutio.print_introduction_msg(configuration)
+MyLocalPutio::Fetcher.new(configuration).run!

data/lib/my-local-putio.rb

@@ -26,4 +26,16 @@ require "my-local-putio/putio_cli"
 require "my-local-putio/fetcher"
 
 module MyLocalPutio
+  def self.print_introduction_msg(configuration)
+    return if configuration.silent
+    puts "Starting My Local Put.io - version #{VERSION}"
+    puts "https://github.com/rafaelbiriba/my-local-putio"
+    puts "============================================="
+    puts "Full path of the local destination: #{File.realdirpath(configuration.local_destination)}"
+    puts ">>> Delete remote files enabled!" if configuration.delete_remote
+    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 "============================================="
+    sleep 2 # In case the configurations are not correct, 2 seconds to kill the command line before run
+  end
 end

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
+    attr_reader :token, :local_destination, :silent, :debug, :socks_host, :socks_port, :delete_remote
     def initialize
       read_args_from_envs!
       parse_args!
@@ -11,18 +11,23 @@ module MyLocalPutio
       @socks_host || @socks_port
     end
 
+    def logger
+      @logger ||= Logger.new(self)
+    end
+
     private
     def parse_args!
       OptionParser.new do |opt|
         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("-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("-d", "--debug", "Debug mode [Developer mode]") { |v| @debug = 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(":")
         end
@@ -40,10 +45,7 @@ module MyLocalPutio
         exit
       end
 
-      unless File.writable?(@local_destination)
-        puts "Cannot write on the local destination path '#{@local_destination}'"
-        exit
-      end
+      destination_folder_checks!
 
       if socks_enabled? && !port_is_open?(@socks_host, @socks_port)
         puts "Cannot connect to socks using '#{@socks_host}:#{@socks_port}'"
@@ -51,6 +53,14 @@ module MyLocalPutio
       end
     end
 
+    def destination_folder_checks!
+      return if File.exists?(@local_destination) && File.writable?(@local_destination)
+      FileUtils.mkdir_p(@local_destination)
+    rescue Errno::EACCES
+      puts "Cannot write on the local destination path '#{@local_destination}'"
+      exit
+    end
+
     def read_args_from_envs!
       @token ||= ENV["PUTIO_TOKEN"]
     end

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

@@ -2,8 +2,10 @@ module MyLocalPutio
   class Fetcher
     attr_reader :configuration, :cli, :logger
 
-    def initialize(configuration, cli, logger)
-      @configuration, @cli, @logger = configuration, cli, logger
+    def initialize(configuration)
+      @configuration = configuration
+      @logger = configuration.logger
+      @cli = PutioCli.new(@configuration)
     end
 
     def run!
@@ -12,42 +14,59 @@ module MyLocalPutio
 
     protected
 
-    def fetch_files(id: nil, path: configuration.local_destination)
-      FileUtils.mkdir_p(path)
-      logger.log "Getting files for #{path}"
+    def fetch_files(id: nil, path: "/")
+      logger.log "Getting file list for #{path}"
       files = cli.get_files(id)["files"]
 
       while files.any?
-        file = OpenStruct.new files.pop
-        if file.content_type == "application/x-directory"
-          fetch_files(id: file.id, path: File.join(path, file.name))
-        else
-  	      file_path = File.join(path, file.name)
-          if File.exists?(file_path) && File.size(file_path) == file.size
-            logger.log "File already downloaded #{file_path}"
-          else
-  	        url = cli.get_download_url file.id
-            logger.log "Downloading: #{file_path}"
-            if ! fetch(url, file_path)
-  	           raise "Unable to download #{file_path}"
-            end
-          end
-        end
+        file = OpenStruct.new(files.pop)
+        process_file(file, path)
       end
     end
 
-    def fetch(url, path)
+    def process_file(file, path)
+      local_file_path = File.join(path, file.name)
+      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)
+      end
+      delete_file(local_file_path, file)
+    end
+
+    def delete_file(local_file_path, file)
+      logger.log "Deleting remote file: #{local_file_path}"
+      cli.delete_file(file.id)
+    end
+
+    def file_exists?(local_file_path, file)
+      file_exists = File.exists?(local_file_path) && File.size(local_file_path) == file.size
+      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", "--progress-bar", "-L", "--retry", "5", "-S", "-C", "-", "-o", path, url.to_s
+        "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
 
-      system(*command)
+      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/logger.rb

@@ -3,7 +3,7 @@ module MyLocalPutio
     attr_reader :configuration
 
     def initialize(configuration)
-        @configuration = configuration
+      @configuration = configuration
     end
 
     def silent?

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

@@ -3,11 +3,11 @@ module MyLocalPutio
     ROOT = "https://api.put.io/v2/"
     attr_reader :configuration, :endpoint, :http, :logger
 
-    def initialize(configuration, endpoint=ROOT, logger)
-      @configuration, @endpoint, @logger = configuration, URI(endpoint), logger
-      @http = http_library.new(@endpoint.host, @endpoint.port)
-      @http.use_ssl = true
-      @http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    def initialize(configuration)
+      @configuration = configuration
+      @logger = configuration.logger
+      @endpoint = URI(ROOT)
+      setup_connection
     end
 
     def get_files(parent_id=nil)
@@ -15,6 +15,17 @@ module MyLocalPutio
       get("files/list", args)
     end
 
+    def delete_file(id)
+      args = {file_ids: id}
+      post("files/delete", args)
+    end
+
+    def delete_file_url
+      url = to_url("files/delete")
+      url.query = URI.encode_www_form to_args()
+      url
+    end
+
     def get_download_url(id)
       url = to_url("files/#{id}/download")
       url.query = URI.encode_www_form to_args()
@@ -31,6 +42,12 @@ module MyLocalPutio
       end
     end
 
+    def setup_connection
+      @http = http_library.new(@endpoint.host, @endpoint.port)
+      @http.use_ssl = true
+      @http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    end
+
     def get(path, args={})
       url = to_url(path)
       url.query = URI.encode_www_form to_args(args)
@@ -39,14 +56,14 @@ module MyLocalPutio
       as_json http.request(req)
     end
 
-    # def post(path, args={})
-    #   url = to_url(path)
-    #   args = to_args(args)
-    #   logger.debug "POST #{url} -- #{args.inspect}"
-    #   req = Net::HTTP::Post.new("/users")
-    #   req.set_form_data(args)
-    #   as_json http.request(req)
-    # end
+    def post(path, args={})
+      url = to_url(path)
+      args = to_args(args)
+      logger.debug "POST #{url} -- #{args.inspect}"
+      req = Net::HTTP::Post.new(url)
+      req.set_form_data(args)
+      as_json http.request(req)
+    end
 
     def to_url(path)
       url = endpoint.dup

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

@@ -1,3 +1,3 @@
 module MyLocalPutio
-  VERSION = "2.1.0"
+  VERSION = "3.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: my-local-putio
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Rafael Biriba
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-19 00:00:00.000000000 Z
+date: 2019-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler