my-local-putio 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1fda62376b386445ef3068eeedc6709cd81d8b51d858ff74f9217a4437c1408
-  data.tar.gz: cf24f1efbaf4d1f0c8524cf2f07f47f56e5935df823eceb2eb0d8ba32b22473a
+  metadata.gz: ebd963a16897bd822f3d645dc96c195ed9c2ab6e0d10c7e3105e8f5f1c9a31bb
+  data.tar.gz: 20504d68d91dee34108c6b3f57253d1a522b25be9c250935459727c5b218ccdb
 SHA512:
-  metadata.gz: 5ab8bb987a3ad33f15e97cac86823c51d70a3f95552c0ccf5790fb1622fcdcd4c40209b58003d0facdf7b366b021d579022f0b8f7450703145db484e660c7c94
-  data.tar.gz: 7dd182463935fbce5ccae3c447f473b13f2df3a3f60fd85bba1775d39bc9fc871701c66a503a9a797eebc986a4fa0c6a9ca0059f9235bf91a27d786ac9daa22d
+  metadata.gz: 320d88bcf89dc9e86ac7f0ce7822148b5599424c5177ac9033cfea2efb2016d2e5740d7e693b968deddb2da68ae18ab5c7497a9b17af407222c37e45e9e1461e
+  data.tar.gz: 2651b2609fd2943ac205d81eeead93662b28a3b0072873649d2cb95b5afa9b4471a41eb2455710ecf4b8875c621eed05e2e3eaa32d127461c2d27ce5ec27ae53

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# v2.1.0
+
+- Introducing SOCKS5 support with `--socks5-proxy` option.
+- Adding `--version` option
+- Small refactoring for error handling during the boot
+
 # v2.0.0
 
 - Breaking changes parameters

data/Gemfile.lock

@@ -1,12 +1,14 @@
 PATH
   remote: .
   specs:
-    my-local-putio (1.0.1)
+    my-local-putio (2.1.0)
+      socksify (= 1.7.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
     rake (10.5.0)
+    socksify (1.7.1)
 
 PLATFORMS
   ruby

data/README.md

@@ -1,4 +1,4 @@
-My Local Put.io
+My Local Put.io [![Gem Version](https://badge.fury.io/rb/my-local-putio.svg)](http://badge.fury.io/rb/my-local-putio) [![Code Climate](https://codeclimate.com/github/rafaelbiriba/my-local-putio/badges/gpa.svg)](https://codeclimate.com/github/rafaelbiriba/my-local-putio)
 ===========
 
 The easiest script to synchronize all your [Put.io](http://put.io) files locally.
@@ -8,6 +8,7 @@ For now the script only supports download the content from your account and keep
 ### 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.
 - Resume broken/stopped downloads, so you don't have to start from the begin of your huge file.
 - Simple and easy to run
 
@@ -40,8 +41,10 @@ For now the script only supports download the content from your account and keep
     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
 
 #### 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.
@@ -54,15 +57,17 @@ Examples:
 
 With Token variable (inline or exporting):
 
-      PUTIO_TOKEN=123 my-local-putio -d Downloads
+      PUTIO_TOKEN=123 my-local-putio -l Downloads
 
       export PUTIO_TOKEN=123
-      my-local-putio -d Downloads
+      my-local-putio --local-destination Downloads/
 
 #### Others attributes:
 * **-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.
+* **--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:
 
@@ -70,6 +75,7 @@ Examples:
     my-local-putio -t 123 -l Downloads --silent
     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:
 

data/lib/my-local-putio.rb

@@ -13,6 +13,8 @@
 # responsibility for any of your downloading acts.
 
 require "net/http"
+require "socksify/http"
+require "socket"
 require "openssl"
 require "ostruct"
 require "yaml"

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

@@ -1,34 +1,62 @@
 module MyLocalPutio
   class Configuration
-    attr_reader :token, :local_destination, :silent, :debug
+    attr_reader :token, :local_destination, :silent, :debug, :socks_host, :socks_port
     def initialize
       read_args_from_envs!
       parse_args!
       validate_args!
     end
 
+    def socks_enabled?
+      @socks_host || @socks_port
+    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("-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("--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
       end.parse!
     end
 
     def validate_args!
       unless @token
-        raise OptionParser::MissingArgument.new("--token")
+        puts "Missing token"
+        exit
       end
 
       unless @local_destination
-        raise OptionParser::MissingArgument.new("--local-destination")
+        puts "Missing local destination"
+        exit
+      end
+
+      unless File.writable?(@local_destination)
+        puts "Cannot write on the local destination path '#{@local_destination}'"
+        exit
+      end
+
+      if socks_enabled? && !port_is_open?(@socks_host, @socks_port)
+        puts "Cannot connect to socks using '#{@socks_host}:#{@socks_port}'"
+        exit
       end
     end
 
     def read_args_from_envs!
       @token ||= ENV["PUTIO_TOKEN"]
     end
+
+    def port_is_open?(host, port)
+      Socket.tcp(host, port, connect_timeout: 5) { true } rescue false
+    end
   end
 end

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

@@ -40,7 +40,13 @@ module MyLocalPutio
       command = [
         "curl", "--progress-bar", "-L", "--retry", "5", "-S", "-C", "-", "-o", path, 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)
     end
   end

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

@@ -5,7 +5,7 @@ module MyLocalPutio
 
     def initialize(configuration, endpoint=ROOT, logger)
       @configuration, @endpoint, @logger = configuration, URI(endpoint), logger
-      @http = Net::HTTP.new(@endpoint.host, @endpoint.port)
+      @http = http_library.new(@endpoint.host, @endpoint.port)
       @http.use_ssl = true
       @http.verify_mode = OpenSSL::SSL::VERIFY_NONE
     end
@@ -23,6 +23,14 @@ module MyLocalPutio
 
     protected
 
+    def http_library
+      if @configuration.socks_enabled?
+        Net::HTTP::SOCKSProxy(@configuration.socks_host, @configuration.socks_port)
+      else
+        Net::HTTP
+      end
+    end
+
     def get(path, args={})
       url = to_url(path)
       url.query = URI.encode_www_form to_args(args)

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

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

data/my-local-putio.gemspec

@@ -26,4 +26,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency "socksify", "1.7.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: my-local-putio
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Rafael Biriba
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-18 00:00:00.000000000 Z
+date: 2019-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: socksify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.7.1
 description: The easiest script to synchronise all your put.io files locally.
 email:
 - biribarj@gmail.com