my-local-putio 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 61a79c61fc4ee64058c994640793d2ca8648f6810f3191096f7075b9eae43ae9
+  data.tar.gz: ff63d69b128c8d017fcdeffa0e345dd775b5fa6d6e14ff3f6526204b127e2630
+SHA512:
+  metadata.gz: 15a91d0b583c45f9997ac9f19c412efc1bf2fad3b63dd6c801f9e86f995ae76dc95a7fc3f6ccde501b9c683f0d529af1c59e3e17131edcb9345f872eeeb0021a
+  data.tar.gz: b84abe3a51341f71ea02658221589d7d78384a003a28d32ff55e258a57c9c04cb4c133d7c30a6ca09b0bafbd02e7cd0a06d6da3eca3d30adfab1311281f2cd95

data/.gitignore

@@ -0,0 +1 @@
+pkg/*

data/.ruby-version

@@ -0,0 +1 @@
+2.6.3

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# v1.0.0
+
+- Rename from *put.io fetcher* to *my local put.io* in order to have more features (and not limited only to fetch files)
+
+# v0.1.0
+
+- First release as gem version

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in putio_fetcher.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,20 @@
+PATH
+  remote: .
+  specs:
+    my-local-putio (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  my-local-putio!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   2.0.2

data/README.md

@@ -0,0 +1,97 @@
+My Local Put.io
+===========
+
+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.
+
+### Features
+
+- 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
+
+#### 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)
+
+- Add a magnet/torrent to the put.io account based on local files or references.
+
+## Copyright Disclaimer
+
+`My Local Put.io` uses the official Put.io API v2. Use this tool for legal purposes only. You are the only one responsible for what you are downloading from your put.io account, ensuring that your download does not infringe any legal or copyright constraints.
+`My Local Put.io` or the script author will not take responsibility for any of your downloading acts.
+
+## Install
+
+* 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:
+
+      gem install my-local-putio
+
+## Usage
+
+    my-local-putio -h
+
+    Usage: my-local-putio [options]
+    -t, --token TOKEN                Put.io access token [REQUIRED]
+    -d, --destination DESTINATION    Destination path [REQUIRED]
+    -v, --verbose                    Show messages and progress bar
+        --debug                      Debug mode [Developer mode]
+
+#### 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.
+* **-d** or **--destination**: Local destination folder
+
+Examples:
+
+    my-local-putio -t 123 -d Downloads
+    my-local-putio -d Downloads --token 123
+
+With Token variable (inline or exporting):
+
+      PUTIO_TOKEN=123 my-local-putio -d Downloads
+
+      export PUTIO_TOKEN=123
+      my-local-putio -d Downloads
+
+#### Others attributes:
+* **-h**: Print the help usage message
+* **-v** or **--verbose**: Show useful information about your downloads
+* **--debug**: Developer mode: Prints everything (also verbose messages) and expose URLs with tokens for debug purposes.
+
+Examples:
+
+    my-local-putio -h
+    my-local-putio -t 123 -d Downloads --verbose
+    my-local-putio -t 123 -d Downloads -v
+    my-local-putio --destination Downloads -t 123 --debug
+
+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
+    ######################################################################## 100.0%
+
+#### Troubleshooting
+
+##### 401 UNAUTHORIZED
+If you token is invalid, the script will stop with `401` error message.
+
+
+## Contributing
+
+First of all, **thank you** for wanting to help!
+
+1. [Fork it](https://help.github.com/articles/fork-a-repo).
+2. Create a feature branch - `git checkout -b more_magic`
+3. Add tests and make your changes
+4. Check if tests are ok - `rake spec`
+5. Commit changes - `git commit -am "Added more magic"`
+6. Push to Github - `git push origin more_magic`
+7. Send a [pull request](https://help.github.com/articles/using-pull-requests)! :heart:

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/my-local-putio

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "my-local-putio"
+
+unless open(__FILE__).flock(File::LOCK_EX | File::LOCK_NB)
+  puts "Script already running..."
+  exit
+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!

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

@@ -0,0 +1,34 @@
+module MyLocalPutio
+  class Configuration
+    attr_reader :token, :destination, :verbose, :debug
+    def initialize
+      read_args_from_envs!
+      parse_args!
+      validate_args!
+    end
+
+    private
+    def parse_args!
+      OptionParser.new do |opt|
+        opt.on("-t", "--token TOKEN", "Put.io access token [REQUIRED]") { |v| @token = v }
+        opt.on("-d", "--destination DESTINATION", "Destination path [REQUIRED]") { |v| @destination = v }
+        opt.on("-v", "--verbose", "Show messages and progress bar") { |v| @verbose = true }
+        opt.on("--debug", "Debug mode [Developer mode]") { |v| @debug = true }
+      end.parse!
+    end
+
+    def validate_args!
+      unless @token
+        raise OptionParser::MissingArgument.new("--token")
+      end
+
+      unless @destination
+        raise OptionParser::MissingArgument.new("--destination")
+      end
+    end
+
+    def read_args_from_envs!
+      @token ||= ENV["PUTIO_TOKEN"]
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+module MyLocalPutio
+  class Fetcher
+    attr_reader :configuration, :cli, :logger
+
+    def initialize(configuration, cli, logger)
+      @configuration, @cli, @logger = configuration, cli, logger
+    end
+
+    def run!
+      fetch_files
+    end
+
+    protected
+
+    def fetch_files(id: nil, path: configuration.destination)
+      FileUtils.mkdir_p(path)
+      logger.log "Getting files 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
+      end
+    end
+
+    def fetch(url, path)
+      command = [
+        "curl", "--progress-bar", "-L", "--retry", "5", "-S", "-C", "-", "-o", path, url.to_s
+      ]
+      command.push("--silent") unless logger.verbose?
+      system(*command)
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+module MyLocalPutio
+  class Logger
+    attr_reader :configuration
+
+    def initialize(configuration)
+        @configuration = configuration
+    end
+
+    def verbose?
+      configuration.verbose
+    end
+
+    def debug?
+      configuration.debug
+    end
+
+    def debug(msg)
+      return unless debug?
+      puts "[DEBUG][#{time_now}] #{msg}"
+    end
+
+    def log(msg)
+      return unless verbose? || debug?
+      puts "[LOG][#{time_now}] #{msg}"
+    end
+
+    private
+
+    def time_now
+      Time.now.strftime("%F %H:%M:%S")
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+module MyLocalPutio
+  class PutioCli
+    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 = Net::HTTP.new(@endpoint.host, @endpoint.port)
+      @http.use_ssl = true
+      @http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    end
+
+    def get_files(parent_id=nil)
+      args = parent_id ? {parent_id: parent_id} : {}
+      get("files/list", args)
+    end
+
+    def get_download_url(id)
+      # Follow redirect plz
+      url = to_url("files/#{id}/download")
+      url.query = URI.encode_www_form to_args()
+      url
+    end
+
+    protected
+
+    def log(msg)
+      return unless configuration.verbose
+      puts msg
+    end
+
+    def get(path, args={})
+      url = to_url(path)
+      url.query = URI.encode_www_form to_args(args)
+      req = Net::HTTP::Get.new(url.request_uri)
+      logger.debug "GET #{url}"
+      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 to_url(path)
+      url = endpoint.dup
+      url.path += path
+      url
+    end
+
+    def to_args(args={})
+      ret = {}
+      args.each_pair do |k,v|
+        ret[k.to_s] = v
+      end
+      args["oauth_token"] = configuration.token
+      args
+    end
+
+    def as_json(res)
+      raise "woot? #{res.inspect}" unless res.is_a?(Net::HTTPSuccess)
+      YAML.load res.body
+    end
+  end
+end

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

@@ -0,0 +1,3 @@
+module MyLocalPutio
+  VERSION = "1.0.0"
+end

data/lib/my-local-putio.rb

@@ -0,0 +1,27 @@
+# Put.io Fetcher
+#
+# Put.io download script! The easiest way to have all all your put.io files locally.
+#
+# Created by: Rafael Biriba - biribarj@gmail.com
+# More info: https://github.com/rafaelbiriba/putio-fetcher
+#
+# Copyright disclaimer:
+# Put.io fetcher uses the official Put.io API v2. Use this tool for legal purposes
+# only. You are the only one responsible for what you are downloading from
+# your put.io account, ensuring that your download does not infringe any legal
+# or copyright constraints. Put.io Fetcher or the script author will not take
+# responsibility for any of your downloading acts.
+
+require "net/http"
+require "openssl"
+require "ostruct"
+require "yaml"
+require "optparse"
+require "putio_fetcher/version"
+require "putio_fetcher/configuration"
+require "putio_fetcher/logger"
+require "putio_fetcher/putio_cli"
+require "putio_fetcher/fetcher"
+
+module MyLocalPutio
+end

data/my-local-putio.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "my-local-putio/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "my-local-putio"
+  spec.version       = MyLocalPutio::VERSION
+  spec.authors       = ["Rafael Biriba"]
+  spec.email         = ["biribarj@gmail.com"]
+
+  spec.summary       = "The easiest script to synchronise all your put.io files locally."
+  spec.description   = "The easiest script to synchronise all your put.io files locally."
+  spec.homepage      = "https://github.com/rafaelbiriba/my-local-putio"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/rafaelbiriba/my-local-putio"
+  spec.metadata["changelog_uri"] = "https://github.com/rafaelbiriba/my-local-putio/blob/master/CHANGELOG.md"
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: my-local-putio
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Rafael Biriba
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: The easiest script to synchronise all your put.io files locally.
+email:
+- biribarj@gmail.com
+executables:
+- my-local-putio
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/my-local-putio
+- lib/my-local-putio.rb
+- lib/my-local-putio/configuration.rb
+- lib/my-local-putio/fetcher.rb
+- lib/my-local-putio/logger.rb
+- lib/my-local-putio/putio_cli.rb
+- lib/my-local-putio/version.rb
+- my-local-putio.gemspec
+homepage: https://github.com/rafaelbiriba/my-local-putio
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/rafaelbiriba/my-local-putio
+  source_code_uri: https://github.com/rafaelbiriba/my-local-putio
+  changelog_uri: https://github.com/rafaelbiriba/my-local-putio/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: The easiest script to synchronise all your put.io files locally.
+test_files: []