tus-client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fb181b60fb3adfe8144c63058f5b8041aff99adcc0951c956dd8d33891c7a7b6
+  data.tar.gz: 98f4f9fccf403e70a49dd3d6ddaa15c9877956db3c43ca69ad0795e90cdfb1ff
+SHA512:
+  metadata.gz: 05c74eaf8f6bbdcc875488dc5b802c910365beacea32cd8ee41135e5560ab89cd121fc565e693d991fbbefbe75226f287c6a6df90b03d3220cc5903395219701
+  data.tar.gz: fc4f57f6b8ef4c16f4216ad119d49d1f938f7e213081304c444ae32a6d67549be19bfb2fb9b7d6e159956c03d70da3a9fa06ca806a38cb35227d76871e6110e7

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at factyy@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tus-client.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Andrei Mochalov (factyy)
+
+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,32 @@
+# Tus::Client
+
+This project is aimed to provide a client tus.io implementation (protocol version 1.0.0)
+
+TODO: Write the additional info
+
+## Installation
+
+TODO: this gem is not published yet!
+
+Just install it from sources
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+TODO: Write the info
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/factyy/tus-tuby-client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/factyy/tus-ruby-client/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Tus::Client project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/factyy/tus-ruby-client/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/tus/client.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'base64'
+
+require 'tus/client/version'
+
+module Tus
+  class Client
+    # 100 MiB is ok for now...
+    CHUNK_SIZE = 100 * 1024 * 1024
+    TUS_VERSION = '1.0.0'
+    NUM_RETRIES = 5
+
+    def initialize(server_url)
+      @server_uri = URI.parse(server_url)
+
+      # better to open the connection now
+      @http = Net::HTTP.start(@server_uri.host, @server_uri.port)
+      # we cache this value for further use
+      @capabilities = capabilities
+    end
+
+    def upload(file_path)
+      raise 'No such file!' unless File.file?(file_path)
+
+      io = File.open(file_path, 'rb')
+
+      uri = create_remote(File.basename(file_path), File.size(file_path))
+      # we use only parameters that are known to the server
+      offset, length = upload_parameters(uri)
+
+      chunks = Enumerator.new do |yielder|
+        yielder << io.read(CHUNK_SIZE)
+      end
+
+      begin
+        offset = chunks.lazy.inject(offset) do |current_offset, chunk|
+          upload_chunk(uri, current_offset, chunk)
+        end
+      rescue StandardError
+        raise 'Broken upload! Cannot send a chunk!'
+      end
+
+      raise 'Broken upload!' unless offset == length
+
+      io.close
+    end
+
+    private
+
+    def capabilities
+      raise 'Uninitialized connection!' unless @http
+
+      response = @http.options(@server_uri.request_uri)
+
+      response['Tus-Extension']&.split(',')
+    end
+
+    def create_remote(file_name, file_size)
+      unless @capabilities.include?('creation')
+        raise 'New file uploading is not supported!'
+      end
+
+      request = Net::HTTP::Post.new(@server_uri.request_uri)
+      request['Content-Length'] = 0
+      request['Upload-Length'] = file_size
+      request['Tus-Resumable'] = TUS_VERSION
+      request['Upload-Metadata'] = "filename: #{Base64.strict_encode64(file_name)},is_confidential"
+
+      response = nil
+
+      NUM_RETRIES.times do
+        begin
+          response = @http.request(request)
+          break
+        rescue StandardError
+          next
+        end
+      end
+
+      unless response.is_a?(Net::HTTPCreated)
+        raise 'Cannot create a remote file!'
+      end
+
+      response['Location']
+    end
+
+    def upload_parameters(uri)
+      request = Net::HTTP::Head.new(uri)
+      request['Tus-Resumable'] = TUS_VERSION
+
+      response = @http.request(request)
+
+      [response['Upload-Offset'], response['Upload-Length']].map(&:to_i)
+    end
+
+    def upload_chunk(uri, offset, chunk)
+      request = Net::HTTP::Patch.new(uri)
+      request['Content-Type'] = 'application/offset+octet-stream'
+      request['Upload-Offset'] = offset
+      request['Tus-Resumable'] = TUS_VERSION
+      request.body = chunk
+
+      response = nil
+
+      NUM_RETRIES.times do
+        begin
+          response = @http.request(request)
+          break
+        rescue StandardError
+          next
+        end
+      end
+
+      raise 'Cannot upload a chunk!' unless response.is_a?(Net::HTTPNoContent)
+
+      resulting_offset = response['Upload-Offset'].to_i
+      unless resulting_offset == offset + chunk.size
+        raise 'Chunk upload is broken!'
+      end
+
+      resulting_offset
+    end
+  end
+end

data/lib/tus/client/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Tus
+  class Client
+    VERSION = '0.0.1'
+  end
+end

data/tus-client.gemspec

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative 'lib/tus/client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'tus-client'
+  spec.version       = Tus::Client::VERSION
+  spec.authors       = ['Andrei Mochalov (factyy)']
+  spec.email         = ['factyy@gmail.com']
+
+  spec.summary       = 'Quick and dirty tus.io protocol ruby client'
+  spec.homepage      = 'https://github.com/factyy/tus-ruby-client'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.require_paths = ['lib']
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: tus-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrei Mochalov (factyy)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-06-17 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- factyy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tus/client.rb
+- lib/tus/client/version.rb
+- tus-client.gemspec
+homepage: https://github.com/factyy/tus-ruby-client
+licenses:
+- MIT
+metadata: {}
+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: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Quick and dirty tus.io protocol ruby client
+test_files: []