tusc 0.6.3 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a74e05041e61223b3679fc6fed4e0300b895ca486afad4b0a449bf34b1f2b14c
-  data.tar.gz: 9b973135e4099e8136fed6165ac12a8e42e9d3d1c7794113f60acef3bf4c149c
+  metadata.gz: 1a71525b9433f284775aff54411ad90d5a8cfe03a69fcbc779f57c7183231215
+  data.tar.gz: 19fa4e6742d79887d5e94796d07ccb87fb39310f05e639aa7a293ee1f78855b4
 SHA512:
-  metadata.gz: 127b4aa96dabc4f1b10cc2898ffa05d6f4076c1a8a8d629388616a10238723b397939fd5fb4797a6687338540ea5db7c4cf33e073d4d6d07a24f2e096142c5cc
-  data.tar.gz: 78a7d81eaf5db02a50c072f0de753d91b8275c3184036ab3fec362bb2a3b4b77d2cd4379d150eb9c05967bc54bd03bc568bc636b6009c6254ba2d9baabd2393a
+  metadata.gz: 7b35190435554684f5e7b923a2ff9ca06b819ffe31f3062d87129d992b901e8fbf9687b8511c24ebff106a2c34a6dac6f4a2af3e121a1332fa4df49e512ba59d
+  data.tar.gz: 9c18e9a86285fda886b4ef7f3838d991cb10f11d5ca145acd9c453931a9b888a392549ab7720ec7b51d7fdc53562014d08f6bd9d656e1be19231ec4ce3b23bcc

data/.travis.yml

@@ -1,8 +1,18 @@
 ---
+# TravisCI config info: https://docs.codeclimate.com/docs/travis-ci-test-coverage
+env:
+  global:
+    - CC_TEST_REPORTER_ID=304a38cb2ff3b8a793c4079709b23fd514812a8bbf694cb290a3afe31cf8f04a
 language: ruby
 bundler_args: --with ci
 cache: bundler
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
 script: bundle exec rake spec_ci
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
 rvm:
   - 2.7
   - 2.6

data/CHANGELOG.md

@@ -4,6 +4,14 @@ 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-20 v0.7.0: Support OPTIONS request, TusClient.chunk_size=, code coverage metric
+- Support OPTIONS request via OptionsRequest/Response classes
+- Increase default chunk_size to 10MB
+- Can assign uploaded chunk_size via TusClient.chunk_size
+- Readme lists "What is supported?"
+- Add Coveralls (for [code coverage](https://coveralls.io/r/mattscilipoti/tusc.rb) in Travis CI)
+- Add CodeClimate support and badge
+
 2020-08-13 v0.6.3: Fix Travis CI error (local tus server)
 - Remove unused 'ougai' gem
 - Move dev/test/ci dependencies to Gemfile

data/Gemfile

@@ -8,10 +8,12 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 gemspec
 
 gem 'amazing_print', '~> 1.2', :group => [:development, :test]
+gem 'coveralls', '~> 0.8', require: false, :group => [:development, :test, :ci]
 gem 'bundler', '~> 1.17', :group => [:development, :test, :ci]
 gem 'pry-byebug', '~> 3.9', :group => [:development, :test]
 gem 'rake', '~> 13.0', :group => [:development, :test, :ci]
 gem 'rspec', '~> 3.0', :group => [:development, :test, :ci]
+gem 'rspec-its', '~> 1.3', require: false, :group => [:development, :test, :ci]
 gem 'tus-server', '~> 2.3', require: false, :group => [:development]
 gem 'webmock', '~> 3.8', require: false, :group => [:development]
 gem 'yard', '~> 0.9', require: false, :group => [:development]

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    tusc (0.6.3)
+    tusc (0.7.0)
 
 GEM
   remote: https://rubygems.org/
@@ -12,10 +12,18 @@ GEM
     byebug (11.1.3)
     coderay (1.1.3)
     content_disposition (1.0.0)
+    coveralls (0.8.23)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.16.1)
+      term-ansicolor (~> 1.3)
+      thor (>= 0.19.4, < 2.0)
+      tins (~> 1.6)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.4.4)
+    docile (1.3.2)
     hashdiff (1.0.1)
+    json (2.3.1)
     method_source (1.0.0)
     pry (0.13.1)
       coderay (~> 1.1)
@@ -37,11 +45,25 @@ GEM
     rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
+    rspec-its (1.3.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.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)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sync (0.5.0)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (1.0.1)
+    tins (1.25.0)
+      sync
     tus-server (2.3.0)
       content_disposition (~> 1.0)
       roda (>= 2.27, < 4)
@@ -57,9 +79,11 @@ PLATFORMS
 DEPENDENCIES
   amazing_print (~> 1.2)
   bundler (~> 1.17)
+  coveralls (~> 0.8)
   pry-byebug (~> 3.9)
   rake (~> 13.0)
   rspec (~> 3.0)
+  rspec-its (~> 1.3)
   tus-server (~> 2.3)
   tusc!
   webmock (~> 3.8)

data/README.md

@@ -1,6 +1,6 @@
 # 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.
+tusc.rb is a (tested) Ruby client for the [tus resumable upload protocol](http://tus.io), for Tus-Resumable v1.0.0. Supporting the Core Protocol and some Extentions (see [What is Supported?](#what-is-supported))
 
 > **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
@@ -10,6 +10,10 @@ tusc.rb is a Ruby client for the [tus resumable upload protocol](http://tus.io),
 
 [![Gem](https://img.shields.io/gem/v/tusc)](https://github.com/mattscilipoti.tusc.rb)
 [![Build Status](https://travis-ci.com/mattscilipoti/tusc.rb.svg?branch=master&logo=travis)](https://travis-ci.com/mattscilipoti/tusc.rb)
+[![Maintainability](https://api.codeclimate.com/v1/badges/93198b592f31d691658d/maintainability)](https://codeclimate.com/github/mattscilipoti/tusc.rb/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/93198b592f31d691658d/test_coverage)](https://codeclimate.com/github/mattscilipoti/tusc.rb/test_coverage)
+[![Test Coverage](https://coveralls.io/repos/mattscilipoti/tusc.rb/badge.svg?branch=master)](https://coveralls.io/r/mattscilipoti/tusc.rb)
+
 ![Ruby 2.7.x](https://img.shields.io/badge/ruby-2.7-blue)
 ![Ruby 2.6.x](https://img.shields.io/badge/ruby-2.6-blue)
 ![Ruby 2.5.x](https://img.shields.io/badge/ruby-2.5-blue)
@@ -36,11 +40,19 @@ Or install it yourself as:
 - Perform a CreationRequest
 - Create an Uploader, passing the:
   - IO object (file)
-  - Upload URL (provided by the Creation Request)
+  - Upload URL (provided by the CreationReponse)
 - 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).
 
+> Each request type has a corresponding response type, which surfaces important information.
+
+> To be uploaded, files are broken into "chunks". You can assign a different chunk size, in bytes,
+> via `TusClient.chunk_size=`.
+> Note: chunk_size is often bigger than the file size (thus creating one chunk).
+
+> You can pass extra information via :extra_headers and/or :body params. This is helpful for special headers (e.g. Upload-Defer-Length) and tus servers that that need extra information.
+
 ### Example
 
 ```
@@ -85,11 +97,29 @@ If the PATCH request got interrupted or failed for another reason, the client ca
 
 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.
 
+## What is supported?
+
+Core Protocol:
+
+- [X] [HEAD](https://tus.io/protocols/resumable-upload.html#head) (via OffsetRequest/Response)
+- [X] [PATCH](https://tus.io/protocols/resumable-upload.html#patch) (via UploadRequest/Response)
+- [X] [OPTIONS](https://tus.io/protocols/resumable-upload.html#options) (via OptionsRequest/Response)
+
+Protocol Extensions:
+
+- [X] [Creation](https://tus.io/protocols/resumable-upload.html#creation) (via CreationRequest/Response)
+- [ ] [Creation With Upload](https://tus.io/protocols/resumable-upload.html#creation-with-upload)
+- [ ] [Checksum](https://tus.io/protocols/resumable-upload.html#checksum)
+- [ ] [Termination](https://tus.io/protocols/resumable-upload.html#termination)
+- [ ] [Concatenation](https://tus.io/protocols/resumable-upload.html#concatenation)
+
+
 ## TODO:
 - [X] Basic upload (via creation request and upload)
 - [X] Can pass tus_server specific/extra headers (like Vimeo requires)
+- [ ] TusMaxSize (from OptionsRequest) informs max_chunk_size of UploadRequest
 - [ ] Can resume failed upload
-- [ ] Supports Upload-Metadata
+- [x] Supports "Upload-Metadata" header for POST (via extra_headers of CreationRequest)
 - [ ] Supports Upload-Defer-Length
 
 ## Development

data/lib/http_service.rb

@@ -9,6 +9,11 @@ class TusClient::HttpService
     _perform(http_request: request, logger: logger)
   end
 
+  def self.options(uri:, headers:, logger:)
+    request = Net::HTTP::Options.new(uri, headers)
+    _perform(http_request: request, logger: logger)
+  end
+
   def self.patch(uri:, headers:, body:, logger:)
     request = Net::HTTP::Patch.new(uri, headers)
     request.body = body

data/lib/tusc.rb

@@ -2,6 +2,7 @@ require 'logger'
 require 'tusc/version'
 require_relative 'core_ext/object/blank'
 require_relative 'tusc/creation_request'
+require_relative 'tusc/options_request'
 require_relative 'tusc/uploader'
 
 class Logger::LogDevice
@@ -33,19 +34,18 @@ module TusClient
   end
 
   def self.log_level
-    @log_level ||= Logger::INFO
+    logger.level
   end
 
   def self.log_level=(value)
-    @logger = nil # invalidate cache
-    @log_level = value
+    logger.level = value
   end
 
   def self.logger
     @logger ||= begin
       # logger = Logger.new(STDOUT)
       Logger.new(log_dir.join('tusc.log'), 1, 1 * MEGABYTE).tap do |logger|
-        logger.level = log_level
+        logger.level = Logger::INFO
       end
     end
   end
@@ -53,4 +53,18 @@ module TusClient
   def self.logger=(value)
     @logger = value
   end
+
+  # Uploaded files are split into "chunks"
+  # This provides the size of each chunk, in bytes
+  def self.chunk_size
+    @chunk_size ||= 10 * TusClient::MEGABYTE
+  end
+
+  # Uploaded files are split into "chunks"
+  # This allows you to assign the size of each chunk, in bytes
+  # chunk_size is often bigger than the size of the uploaded file (thus creating one chunk)
+  def self.chunk_size=(value)
+    raise(ArgumentError, "chunk_size must be an Integer (#{value}).") unless value.is_a?(Integer)
+    @chunk_size = value
+  end
 end

data/lib/tusc/options_request.rb

@@ -0,0 +1,35 @@
+require_relative '../http_service'
+require_relative 'options_response'
+
+# Asks tus server for the provided options (aka server configuration)
+class TusClient::OptionsRequest
+  attr_reader :extra_headers, :tus_server_uri
+  def initialize(tus_server_url:, extra_headers: {})
+    tus_server_uri = tus_server_url.is_a?(URI) ? tus_server_url : URI.parse(tus_server_url)
+    unless tus_server_uri.is_a?(URI::HTTP) && !tus_server_uri.host.nil?
+      raise URI::InvalidURIError, "Could NOT parse host from #{tus_server_url.inspect}"
+    end
+
+    @tus_server_uri = tus_server_uri
+    @extra_headers = extra_headers
+  end
+
+  def headers
+    extra_headers
+  end
+
+  def logger
+    @logger ||= TusClient.logger
+  end
+
+  # Retrieves server config via a OPTIONS request to the tus server
+  # Returns an OptionsResponse)
+  def perform
+    response = TusClient::HttpService.options(
+      uri: tus_server_uri,
+      headers: headers,
+      logger: logger
+    )
+    TusClient::OptionsResponse.new(response)
+  end
+end

data/lib/tusc/options_response.rb

@@ -0,0 +1,36 @@
+require_relative 'responsorial'
+
+# Parses the response from an OptionsRequest
+#
+# Surfacing important info:
+# - max_chunk_size
+# - supported_checksums
+# - supported_extensions
+# - supported_versions
+class TusClient::OptionsResponse
+  include TusClient::Responsorial
+  def initialize(response)
+    @response = response
+  end
+
+  def max_chunk_size
+    raw.header['Tus-Max-Size']
+  end
+
+  def success?
+    success_codes = [200, 204]
+    success_codes.include?(status_code)
+  end
+
+  def supported_checksums
+    raw.header['Tus-Checksum-Algorithm']
+  end
+
+  def supported_extensions
+    raw.header['Tus-Extension']
+  end
+
+  def supported_versions
+    raw.header['Tus-Version']
+  end
+end

data/lib/tusc/responsorial.rb

@@ -1,4 +1,7 @@
-# shared interface for Response objects
+# Shared interface for Response objects
+#
+# re·​spon·​so·​ri·​al | \ rə̇¦spän¦sōrēəl, (¦)rē¦s- \
+# : relating to or consisting of responses
 module TusClient::Responsorial
   def body
     body = raw.body

data/lib/tusc/uploader.rb

@@ -8,10 +8,6 @@ require_relative 'offset_request'
 class TusClient::Uploader
   attr_reader :extra_headers, :io, :upload_url
 
-  def self.chunk_size
-    10 * TusClient::MEGABYTE
-  end
-
   def self.default_content_type
     'application/offset+octet-stream'
   end
@@ -45,8 +41,10 @@ class TusClient::Uploader
     delete upload_url
   end
 
+  # Uploaded files are split into "chunks"
+  # This provides the size, in bytes, of each chunk
   def chunk_size
-    @chunk_size ||= TusClient::Uploader.chunk_size
+    @chunk_size ||= TusClient.chunk_size
   end
 
   def content_type

data/lib/tusc/version.rb

@@ -1,3 +1,3 @@
 module TusClient
-  VERSION = '0.6.3'.freeze
+  VERSION = '0.7.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tusc
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.7.0
 platform: ruby
 authors:
 - Matt Scilipoti
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-08-14 00:00:00.000000000 Z
+date: 2020-08-20 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -41,6 +41,8 @@ files:
 - lib/tusc/creation_response.rb
 - lib/tusc/offset_request.rb
 - lib/tusc/offset_response.rb
+- lib/tusc/options_request.rb
+- lib/tusc/options_response.rb
 - lib/tusc/responsorial.rb
 - lib/tusc/upload_request.rb
 - lib/tusc/upload_response.rb