clientus 0.1.0.dev

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e320aff4b0c5e9ead91a515f95dc708423b2e278
+  data.tar.gz: c7bdea9012df96ba9a3c0d44d7d0484eacce3988
+SHA512:
+  metadata.gz: daec6499149ca9b627a41cb9b449ae144aca595dbe5cde6fc8f467898b3b106c5e9772ad0aaae173af6d7e4617c7e1d403ba31a8f0823577fd0918d6b4f74520
+  data.tar.gz: a702a56a0f2d5a6f945cd7840a2741bc8867c1f793ed66af3499fffda9b912d9b99da1721f98847ba325e7a6349dda1e6bd6792cc367413c209348522a30342a

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,7 @@
+AllCops:
+  TargetRubyVersion: 2.4.6
+  Exclude:
+  - bin/*
+  - clientus.gemspec
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in clientus.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    clientus (0.1.0.dev)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.1)
+    parallel (1.19.2)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (1.8.2)
+    rexml (3.2.4)
+    rubocop (1.0.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 0.6.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.0.0)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  x64-mingw32
+
+DEPENDENCIES
+  clientus!
+  rake (~> 12.0)
+  rubocop (~> 1.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Oleg Ivanov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,86 @@
+# Clientus
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/clientus`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'clientus'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install clientus
+
+## Usage
+
+Case 1: Suppose you have an URL of the uploading interface
+```ruby
+require 'clientus'
+
+# simply create a client instance
+client = Clientus::Client.new(url)
+
+# then upload your file!
+client.upload('foo/bar.txt')
+
+# now bar.txt is somewhere on the server (or some exception appeared.. ouch!)
+```
+
+Case 2: You have some headers you want to pass along (ex.: session sid)
+```ruby
+require 'clientus'
+
+# describe your headers
+# NOTE: tus-specific headers will be rewritten or adjusted
+# ex.: if you defined Tus-Resumable header, its value will be replaced with one from the server
+custom_headers = {
+  'Cookie' => 'sid=09876543211234567890'
+}
+
+# pass your headers when creating a client instance
+client = Clientus::Client.new(url, additional_headers: custom_headers)
+
+# upload a file!
+client.upload('foo/bar.txt')
+```
+
+Case 3: You want to use some custom http config (ex: you want to turn off the sertificate verification)
+```ruby
+require 'clientus'
+
+# describe a required http config
+http_params = {
+  use_ssl: true,
+  verify_mode: OpenSSL::SSL::VERIFY_NONE
+}
+
+# pass your headers when creating a client instance
+client = Clientus::Client.new(url, http_params: http_params)
+
+# upload a file!
+client.upload('foo/bar.txt')
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/clientus.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "clientus"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/clientus.gemspec

@@ -0,0 +1,31 @@
+require_relative 'lib/clientus/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "clientus"
+  spec.version       = Clientus::VERSION
+  spec.authors       = ["Oleg Ivanov"]
+  spec.email         = ["gluk.main+github@gmail.com"]
+
+  spec.summary       = %q{A simple client for the Tus protocol}
+  spec.description   = %q{A client for the Tus protocol enabling file uploads}
+  spec.homepage      = "https://github.com/glUk-skywalker/clientus"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/glUk-skywalker/clientus"
+  spec.metadata["changelog_uri"] = "<none yet>"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  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        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'rubocop', '~> 1.0'
+end

data/lib/clientus.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'net/http'
+
+require 'clientus/error'
+require 'clientus/version'
+require 'clientus/client'
+require 'clientus/server'
+require 'clientus/upload_file'
+require 'helpers'

data/lib/clientus/client.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module Clientus
+  # Client that transfers files. The main class.
+  class Client
+    CHUNK_SIZE = 100 * 1024 * 1024 # 100MB
+
+    def initialize(url, http_params: {}, additional_headers: {})
+      @server_uri = URI.parse url
+      @http = Net::HTTP.start(@server_uri.host, @server_uri.port, http_params)
+      @additional_headers = additional_headers
+
+      server_options = @http.options(@server_uri.request_uri)
+      @server = Server.new(server_options)
+    end
+
+    def upload(file_path)
+      # checking here instead of checking in 'create!' to avoid wasting time
+      # for needless file reading
+      @server.raise_if_unsupported(:creation)
+
+      file = read_file(file_path)
+
+      location = create!(file)
+
+      start_offset = 0
+      loop do
+        end_offset = start_offset + CHUNK_SIZE
+        chunk_data = file.data[start_offset..end_offset]
+
+        upload_chunk(location, start_offset, chunk_data)
+        break if end_offset >= file.size
+
+        start_offset = end_offset + 1
+      end
+      terminate!(location)
+    end
+
+    private
+
+    def read_file(file_path)
+      data = File.open(file_path, 'rb', &:read)
+      size = File.size(file_path)
+      name = File.basename(file_path)
+      UploadFile.new(name, size, data)
+    end
+
+    def create!(file)
+      # TODO: refactor this
+      request = default_request(:post, @server_uri.request_uri)
+      request['Content-Length'] = 0
+      request['Upload-Length'] = file.size
+      request['Upload-Metadata'] ||= "filename #{file.encoded_name}"
+      unless request['Upload-Metadata'].include?('filename ')
+        request['Upload-Metadata'] += ",filename #{file.encoded_name}"
+      end
+
+      res = @http.request(request)
+      return res['Location'] if res.is_a?(Net::HTTPCreated)
+
+      raise(Error, "failed to create remote file: bad resonse type: #{res.class}; body: #{res.body}")
+    end
+
+    def upload_chunk(uri, offset, chunk)
+      request = default_request(:patch, uri)
+      request['Content-Type'] = 'application/offset+octet-stream'
+      request['Upload-Offset'] = offset
+      request.body = chunk
+      @http.request(request)
+    end
+
+    def terminate!(uri)
+      @server.raise_if_unsupported(:termination)
+      request = default_request(:delete, uri)
+      @http.request(request)
+    end
+
+    def default_request(method, uri)
+      request_class = Object.const_get "Net::HTTP::#{method.to_s.capitalize}"
+      request = request_class.new(uri)
+      @additional_headers.each { |k, v| request[k] = v }
+      request['Tus-Resumable'] = @server.tus_version
+      request
+    end
+  end
+end

data/lib/clientus/error.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Clientus
+  class Error < StandardError; end
+end

data/lib/clientus/server.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Clientus
+  # Holds server info
+  class Server
+    attr_reader :tus_version
+
+    def initialize(http_options)
+      @operations = http_options['Tus-Extension'].split(',')
+      @tus_version = http_options['tus-version']
+      raise(Error, 'The server did not provide the tus version.') unless @tus_version
+    end
+
+    def raise_if_unsupported(extension)
+      ext = extension.to_s
+      return if @operations.include?(ext)
+      raise(Error, "The server does not support #{ext}")
+    end
+  end
+end

data/lib/clientus/upload_file.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Clientus
+  # Holds file information
+  class UploadFile
+    attr_reader :name, :size, :data
+
+    def initialize(name, size, data)
+      @name = name
+      @data = data
+      @size = size
+    end
+
+    def encoded_name
+      # TODO: investigate why we need to exclude CR/LF in the end of encoded string
+      Base64.encode64(@name)[0..-2]
+    end
+  end
+end

data/lib/clientus/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Clientus
+  VERSION = '0.1.0.dev'
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: clientus
+version: !ruby/object:Gem::Version
+  version: 0.1.0.dev
+platform: ruby
+authors:
+- Oleg Ivanov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-10-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: A client for the Tus protocol enabling file uploads
+email:
+- gluk.main+github@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- clientus.gemspec
+- lib/clientus.rb
+- lib/clientus/client.rb
+- lib/clientus/error.rb
+- lib/clientus/server.rb
+- lib/clientus/upload_file.rb
+- lib/clientus/version.rb
+homepage: https://github.com/glUk-skywalker/clientus
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/glUk-skywalker/clientus
+  source_code_uri: https://github.com/glUk-skywalker/clientus
+  changelog_uri: "<none yet>"
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14.4
+signing_key: 
+specification_version: 4
+summary: A simple client for the Tus protocol
+test_files: []