tusc 0.6.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b7813e93df83778b66645bbe46850bca1037d9e655d2569ec1fd704de5969dc2
+  data.tar.gz: f2ff22d2ddd57c4a146c1d6059c7c59ede62201d96e4c5d8af67c99487d318df
+SHA512:
+  metadata.gz: 0a7165397f3cc3be3d77e177f312284c3b9852994d4f068c3b622eb489b34e81d437eecc5491e7165b16287f241232a3dee758774f79133adb959020e3e09d1b
+  data.tar.gz: d36729b3d3bb537edc066700fae5c19f4663966ba7a48cc836e4bee7b353d595a72a596b1de5848d807c90225a874265eb9060425ca987f84646701fbb64573f

data/.editorconfig

@@ -0,0 +1,26 @@
+# EditorConfig is awesome: http://EditorConfig.org
+# tldr: A single point of truth for code editor configuration
+
+# conventions
+# - sort each section by alpha
+# - assign global defaults, then indicate exceptions to those rules
+
+# top-most EditorConfig file
+root = true
+
+# Default settings
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+# Batch files
+[**.bat]
+end_of_line = crlf
+
+# Python
+[**.py]
+indent_size = 4
+indent_style = space

data/.gitignore

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

data/.tool-versions

@@ -0,0 +1,2 @@
+nodejs 14.5.0
+ruby 2.7.1

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.0
+before_install: gem install bundler -v 1.17.2

data/CHANGELOG.md

@@ -0,0 +1,83 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a CHANGELOG](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+2020-08-12 v0.6.1: Prepare for deploy to RubyGems
+- Updated docs, using yard.
+
+2020-08-12 v0.6.0: Revert to basic ruby Logger, level=INFO
+- switch from Ougai::Logger to Ruby Logger.
+  - Now, ruby/rails app can assign, e.g. `TusClient.logger = Rails.logger`
+  - Still logs :source
+- Logger.level = Logger::INFO (was ERROR)
+- Add binstub `bin/rackup` (for testing)
+
+2020-08-06 v0.5.0: Logged 'source' is tus code. Namespace support classes.
+- Move Responsorial to TusClient namespace
+- Move HttpService to TusClient namespace
+- Move HttpService to lib/. lib/tusc/ is reserved for tus code.
+- Logged 'source' is code from tusc dir, not support libraries
+- Tests use std log (log/tusc.log) vs. log/tusc_test.log
+
+2020-08-05 v0.4.6: FIX CreationResponse#body, HttpService, tweak logs
+- FIX CreationResponse#body (for blank body)
+- Extract HttpService (head, patch, post)
+- CreationRequest logs body (used by some tus servers; e.g. Vimeo)
+- Log request/response vs. sending/receiving
+- #truncate uses ellipse (vs. 3 periods)
+
+2020-07-28 v0.4.5: FIX: Upload 413 code. Extract UploadRequest (used by Uploader)
+- FIX: Upload 413 code ("resource's size exceeded"), by adding ContentType to UploadRequest
+- Extract UploadRequest from Uploader.push_chunk.
+
+2020-07-27 v0.4.4: FIX: some tus servers return 200 (vs. 204) for upload request
+- added specs to split file into multiple chunks
+
+2020-07-24 v0.4.3: FIX: Can upload video files. Testing via tus-server.
+- Added tests against local tus-server
+- FIX: Uploader now supports uploading video files (using octet-stream vs. detected content type)
+  - removes dependency on MimeMagic
+- All *Response objects have basic interface: raw, status_code, success?
+
+2020-07-23 v0.4.2: FIX: Uploader#push_chunk had error logging (truncated) body
+
+2020-07-23 v0.4.1: FIX: Upload#perform seeks correct offset.
+
+2020-07-23 v0.4.0: FIX: OffsetResponse default offset, Uploader#content_type
+- FIX: OffsetResponse#offset is 0, if Upload-Offset header is not present
+- Uploader#content_type detects or uses default
+
+2020-07-23 v0.3.0: FIX: content_type. Allow setting TusClient.log_level
+- debug by setting `TusClient.log_level = Logger::DEBUG`
+- reduce log rollover sizes to 1MB (200kB for testing)
+- FIX: Get appropriate field from MimeMagic or return default type
+
+2020-07-22 v0.2.0: Uploader & OffsetRequest accept extra_headers
+- Uploader passes extra_headers to OffsetRequest
+
+2020-07-22 v0.1.6: FIX Requesting offset
+- FIX: Uploader#offset_request(er)
+- OffsetRequest: accepts URL or URI
+
+2020-07-22 v0.1.5: FIX Requires, FIX #blank CONST conflicts
+- FIX: Uploader requires OffsetRequest
+- FIX: #blank no longer creates BLANK_RE const if rails already has (via client)
+
+2020-07-22 v0.1.4: CreationResponse#success?, #blank?
+- CreationResponse: body is parsed from JSON
+- Copy/paste #blank? from Rails/ActiveSupport
+- FIX: Uploader.from_file_path factory method (named args)
+
+2020-07-22 v0.1.3: CreationRequest accepts :body, :extra_headers
+- i.e. Vimeo tus server requires info to be included in the request.
+
+2020-07-22 v0.1.2 CreationResponse provides #status_code, #body, #raw
+
+2020-07-22 v0.1.0: Removed ActiveSupport dependency
+
+2020-07-21 v0.1.0: Support basic requests:
+- Creation Request (POST): requests URL we can upload to
+- Current Offset Request (HEAD): requests current offset fo specified file upload url
+- Upload Request (PATCH): uploads a chunk of the file

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 matt@scilipoti.name. 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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+ruby '2.7.1'
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in tusc_rb.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,76 @@
+PATH
+  remote: .
+  specs:
+    tusc (0.6.1)
+      ougai (~> 1.8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    amazing_print (1.2.1)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    content_disposition (1.0.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.4.4)
+    hashdiff (1.0.1)
+    method_source (1.0.0)
+    oj (3.10.8)
+    ougai (1.8.5)
+      oj (~> 3.10)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    public_suffix (4.0.5)
+    rack (2.2.3)
+    rake (13.0.1)
+    roda (3.34.0)
+      rack
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    safe_yaml (1.0.5)
+    tus-server (2.3.0)
+      content_disposition (~> 1.0)
+      roda (>= 2.27, < 4)
+    webmock (3.8.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    yard (0.9.25)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  amazing_print (~> 1.2)
+  bundler (~> 1.17)
+  pry-byebug (~> 3.9)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  tus-server (~> 2.3)
+  tusc!
+  webmock (~> 3.8)
+  yard (~> 0.9)
+
+RUBY VERSION
+   ruby 2.7.1p83
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Matt Scilipoti
+
+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,109 @@
+# tusc.rb: Tus Client for Ruby
+
+tusc.rb is a Ruby client for the [tus resumable upload protocol](http://tus.io), version 1.0.0.
+
+> **tus** is a protocol based on HTTP for *resumable file uploads*. Resumable
+> means that an upload can be interrupted at any moment and can be resumed without
+> re-uploading the previous data again. An interruption may happen willingly, if
+> the user wants to pause, or by accident in case of an network issue or server
+> outage.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tusc'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install tusc
+
+## Usage
+
+- Perform a CreationRequest
+- Create an Uploader, passing the:
+  - IO object (file)
+  - Upload URL (provided by the Creation Request)
+- Start the upload
+
+> We recommend reviewing the specs in `spec/against_tus_server_spec.rb`. There are examples of uploading files (e.g. text, video).
+
+### Example
+
+```
+File.open('path/to/file') do |file|
+  creation_request = TusClient::CreationRequest.new(
+    tus_creation_url: 'https://example.com',
+    file_size: file.size
+  )
+  creation_response = creation_request.perform
+  uploader = TusClient::Uploader.new(
+    io: file,
+    upload_url: creation_response.upload_url.to_s
+  )
+  uploader.perform
+end
+```
+
+## Logging
+
+We log to `log/tusc.log`.
+
+- You can adjust verbosity by setting `TusClient.log_level`
+- It defaults to `Logger::INFO`
+
+> Tip: Can combine with Rails logs using `TusClient.logger = Rails.logger`
+
+> Tip: "bunyan" is good tool for viewing "pretty" formatted logs. Note: we're recommend [the CLI](https://github.com/trentm/node-bunyan#installation), not the nodejs library.
+
+## tus overview
+
+> from https://tus.io/faq.html#how-does-tus-work
+
+A tus upload is broken down into different HTTP requests, where each one has a different purpose:
+
+At first, the client sends a POST request to the server to initiate the upload. This upload creation request tells the server basic information about the upload, such as its size or additional metadata. If the server accepts this upload creation request, it will return a successfully response with the Location header set to the upload URL. The upload URL is used to unique identify and reference the newly created upload resource.
+
+Once the upload has been create, the client can start to transmit the actual upload content by sending a PATCH request to the upload URL, as returned in the previous POST request. Idealy, this PATCH request should contain as much upload content as possible to minimize the upload duration. The PATCH request must also contain the Upload-Offset header which tells the server at which byte-offset the server should write the uploaded data. If the PATCH request successfully transfers the entire upload content, then your upload is done!
+
+If the PATCH request got interrupted or failed for another reason, the client can attempt to resume the upload. In order to resume, the client must know how much data the server has received. This information is obtained by sending a HEAD request to the upload URL and inspecting the returned Upload-Offset header. Once the client knows the upload offset, it can send another PATCH request until the upload is completely down.
+
+Optionally, if the client wants to delete an upload because it won’t be needed anymore, a DELETE request can be sent to the upload URL. After this, the upload can be cleaned up by the server and resuming the upload is not possible anymore.
+
+## TODO:
+- [X] Basic upload (via creation request and upload)
+- [X] Can pass tus_server specific/extra headers (like Vimeo requires)
+- [ ] Can resume failed upload
+- [ ] Supports Upload-Metadata
+- [ ] Supports Upload-Defer-Length
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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).
+
+## Testing
+
+- We use rspec, so everything is under `spec/` directory.
+- Run via `bin/rspec` or `rake` (the default rake task is :spec)
+- Fixture files used for testing are in `spec/fixtures`.
+- To test against an actual tus server, run one via `bin/rackup`
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mattscilipoti/tusc.rb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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 TusClient project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mattscilipoti/tusc.rb/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec