tusc 0.6.1

data/lib/tusc/creation_response.rb

@@ -0,0 +1,26 @@
+require_relative 'responsorial'
+
+# Parses the response from a CreationRequest
+#
+# Surfacing important info:
+# - location -> upload_uri
+class TusClient::CreationResponse
+  include TusClient::Responsorial
+  def initialize(response)
+    @response = response
+  end
+
+  def location
+    raw.header && raw.header['Location']
+  end
+
+  def success?
+    result = status_code == 201
+    result &= (location =~ URI::ABS_URI) unless location.blank?
+    result
+  end
+
+  def upload_uri
+    URI.parse(location) unless location.blank?
+  end
+end

data/lib/tusc/offset_request.rb

@@ -0,0 +1,42 @@
+require_relative '../http_service'
+require_relative 'offset_response'
+
+# Asks tus server for appriopriate offset
+#  for specific file, via upload_url
+class TusClient::OffsetRequest
+  attr_reader :extra_headers, :upload_uri
+  def initialize(upload_url:, extra_headers: {})
+    upload_uri = upload_url.is_a?(URI) ? upload_url : URI.parse(upload_url)
+    unless upload_uri.is_a?(URI::HTTP) && !upload_uri.host.nil?
+      raise URI::InvalidURIError, "Could NOT parse host from #{upload_url.inspect}"
+    end
+
+    @upload_uri = upload_uri
+    @extra_headers = extra_headers
+  end
+
+  def headers
+    {
+      'Tus-Resumable' => supported_tus_resumable_version
+    }.merge(extra_headers)
+  end
+
+  def logger
+    @logger ||= TusClient.logger
+  end
+
+  # Retrieves offset via a HEAD request to the tus server
+  # Returns the offset (in a OffsetResponse)
+  def perform
+    response = TusClient::HttpService.head(
+      uri: upload_uri,
+      headers: headers,
+      logger: logger
+    )
+    TusClient::OffsetResponse.new(response)
+  end
+
+  def supported_tus_resumable_version
+    '1.0.0'
+  end
+end

data/lib/tusc/offset_response.rb

@@ -0,0 +1,20 @@
+require_relative 'responsorial'
+
+# Parses the response from an OffsetRequest
+#
+# Surfacing important info:
+# - offset
+class TusClient::OffsetResponse
+  include TusClient::Responsorial
+  def initialize(response)
+    @response = response
+  end
+
+  def offset
+    raw.header['Upload-Offset'].to_i # nil.to_i == 0
+  end
+
+  def success?
+    status_code == 204 && (offset >= 0)
+  end
+end

data/lib/tusc/responsorial.rb

@@ -0,0 +1,15 @@
+# shared interface for Response objects
+module TusClient::Responsorial
+  def body
+    body = raw.body
+    body.blank? ? '' : JSON.parse(body)
+  end
+
+  def raw
+    @response
+  end
+
+  def status_code
+    raw.code.to_i
+  end
+end

data/lib/tusc/upload_request.rb

@@ -0,0 +1,64 @@
+require_relative '../http_service'
+require_relative 'upload_response'
+
+module TusClient
+  # Asks tus server to upload a chunk of a file, from a specific offset
+  class UploadRequest
+    attr_reader :chunk_to_upload, :extra_headers, :file_size, :offset, :upload_uri
+
+    def initialize(upload_uri:, chunk_to_upload:, offset:, file_size:, extra_headers: {})
+      upload_uri = upload_uri.is_a?(URI) ? upload_uri : URI.parse(upload_uri)
+      unless upload_uri.is_a?(URI::HTTP) && !upload_uri.host.nil?
+        raise URI::InvalidURIError, "Could NOT parse host from #{upload_uri.inspect}"
+      end
+
+      unless chunk_to_upload.is_a?(String)
+        raise ArgumentError, "chunk_to_upload must be a String, found (#{chunk_to_upload}:#{chunk_to_upload.class.name})"
+      end
+
+      unless file_size.is_a?(Integer)
+        raise ArgumentError, "file_size must be an Integer, found (#{file_size}:#{file_size.class.name})"
+      end
+
+      unless offset.is_a?(Integer)
+        raise ArgumentError, "offset must be an Integer, found (#{offset}:#{offset.class.name})"
+      end
+
+      @chunk_to_upload = chunk_to_upload
+      @extra_headers = extra_headers
+      @file_size = file_size
+      @offset = offset
+      @upload_uri = upload_uri
+    end
+
+    def default_content_type
+      'application/offset+octet-stream'
+    end
+
+    def headers
+      {
+        'Content-Type' => default_content_type,
+        'Tus-Resumable' => supported_tus_resumable_version,
+        'Upload-Offset' => offset.to_s
+      }.merge(extra_headers)
+    end
+
+    def logger
+      @logger ||= TusClient.logger
+    end
+
+    def perform
+      response = TusClient::HttpService.patch(
+        uri: upload_uri,
+        headers: headers,
+        body: chunk_to_upload,
+        logger: logger
+      )
+      TusClient::UploadResponse.new(response, file_size)
+    end
+
+    def supported_tus_resumable_version
+      '1.0.0'
+    end
+  end
+end

data/lib/tusc/upload_response.rb

@@ -0,0 +1,37 @@
+require_relative 'responsorial'
+
+# Parses the response from an UploadRequest
+#
+# Surfacing important info:
+# - complete?
+# - incomplete?
+# - offset
+# - success?
+class TusClient::UploadResponse
+  include TusClient::Responsorial
+  attr_reader :file_size
+  def initialize(response, file_size)
+    @response = response
+    @file_size = file_size
+  end
+
+  def complete?
+    offset >= file_size
+  end
+
+  def incomplete?
+    offset < file_size
+  end
+
+  def offset
+    raw.header['Upload-Offset'].to_i
+  end
+
+  def successful_status_codes
+    [200, 204]
+  end
+
+  def success?
+    successful_status_codes.include?(status_code)
+  end
+end

data/lib/tusc/uploader.rb

@@ -0,0 +1,141 @@
+require 'net/http'
+require_relative '../core_ext/string/truncate'
+require_relative 'upload_request'
+require_relative 'upload_response'
+require_relative 'offset_request'
+
+# Uploads a file to a tus server
+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
+
+  def self.from_file_path(file_path:, upload_url:, extra_headers: {})
+    raise ArgumentError, "file_path is required (#{file_path})" if file_path.blank?
+
+    file_pathname = Pathname.new(file_path)
+    raise ArgumentError, "Passed file does NOT exist: #{file_pathname.inspect}" unless file_pathname.exist?
+
+    new(io: file_pathname.open, upload_url: upload_url, extra_headers: extra_headers)
+  end
+
+  def initialize(io:, upload_url:, extra_headers: {})
+    # fail ArgumentError.new("io must be an IO object") unless io.is_a?(IO) || io.is_a?(StringIO)
+    %i[size read close].each do |required_method|
+      raise ArgumentError, "io must respond to ##{required_method}" unless io.respond_to?(required_method)
+    end
+    raise ArgumentError, "upload_url is required (#{upload_url})" if upload_url.blank?
+    raise ArgumentError, "upload_url must be a valid url (#{upload_url})" unless upload_url =~ URI::ABS_URI
+
+    @io = io
+    @upload_url = upload_url
+    @extra_headers = extra_headers
+  end
+
+  # 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.
+  def cancel_upload
+    delete upload_url
+  end
+
+  def chunk_size
+    @chunk_size ||= TusClient::Uploader.chunk_size
+  end
+
+  def content_type
+    # We used to detect content type, using MimeMagic,
+    #  but the videos only uploaded if we used the default (octet-stream)
+    #  So... we just use the default
+    default_content_type
+  end
+
+  def default_content_type
+    self.class.default_content_type
+  end
+
+  def headers
+    {
+      'Content-Type' => content_type,
+      'Tus-Resumable' => tus_resumable_version,
+      'Upload-Offset' => 0.to_s
+    }.merge(extra_headers)
+  end
+
+  def logger
+    @logger ||= TusClient.logger
+  end
+
+  def offset_requester
+    @offset_requester ||= TusClient::OffsetRequest.new(upload_url: upload_uri, extra_headers: extra_headers)
+  end
+
+  # Performs the upload, one chunk at a time
+  # Starts by asking for the currnet offset
+  # Each follow-on request, returns the current offset.
+  def perform
+    # TODO: asynch?
+    logger.debug { 'Starting upload...' }
+
+    offset = retrieve_offset
+    begin
+      logger.debug { ['Reading io...', { size: size, offset: offset, chunk_size: chunk_size }] }
+      io.pos = offset
+      chunk = io.read(chunk_size)
+      upload_response = push_chunk(chunk, offset)
+      unless upload_response.success?
+        raise "Issue uploading file: #{{ code: upload_response.status_code, message: upload_response.body }}."
+      end
+
+      offset = upload_response.offset
+    end while upload_response.success? && upload_response.incomplete?
+
+    io.close
+    upload_response
+  end
+
+  def push_chunk(chunk, offset)
+    push_chunk_via_upload_request(chunk, offset)
+  end
+
+  def push_chunk_via_upload_request(chunk, offset)
+    upload_request = TusClient::UploadRequest.new(
+      upload_uri: upload_url,
+      chunk_to_upload: chunk,
+      offset: offset,
+      file_size: size,
+      extra_headers: extra_headers
+    )
+    upload_request.perform
+  end
+
+  def retrieve_offset
+    offset_requester.perform.offset
+  end
+
+  def size
+    @size ||= io.size
+  end
+
+  def tus_resumable_version
+    '1.0.0'
+  end
+
+  def upload_incomplete
+    retrieve_offset < size
+  end
+
+  def upload_uri
+    @upload_uri ||= URI.parse(upload_url)
+  end
+
+  def video_url
+    upload_response.fetch('uri')
+  end
+end

data/lib/tusc/version.rb

@@ -0,0 +1,3 @@
+module TusClient
+  VERSION = '0.6.1'.freeze
+end

data/tusc.gemspec

@@ -0,0 +1,48 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tusc/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'tusc'
+  spec.version       = TusClient::VERSION
+  spec.authors       = ['Matt Scilipoti']
+  spec.email         = ['matt@scilipoti.name']
+
+  spec.summary       = 'Ruby client for [tus](https://tus.io/): open protocol for resumable file uploads'
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = 'https://github.com/mattscilipoti/tusc.rb'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata['allowed_push_host'] = 'https://rubygems.org/???'
+
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://github.com/mattscilipoti/tusc.rb'
+    # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # 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.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'ougai', '~> 1.8' # for structured logging, child log per file
+
+  spec.add_development_dependency 'amazing_print', '~> 1.2'
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'pry-byebug', '~> 3.9'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'tus-server', '~> 2.3'
+  spec.add_development_dependency 'webmock', '~> 3.8'
+  spec.add_development_dependency 'yard', '~> 0.9'
+end

metadata

@@ -0,0 +1,202 @@
+--- !ruby/object:Gem::Specification
+name: tusc
+version: !ruby/object:Gem::Version
+  version: 0.6.1
+platform: ruby
+authors:
+- Matt Scilipoti
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-08-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ougai
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: amazing_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: tus-server
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description:
+email:
+- matt@scilipoti.name
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".tool-versions"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/rackup
+- bin/rspec
+- bin/setup
+- config.ru
+- lib/core_ext/object/blank.rb
+- lib/core_ext/string/truncate.rb
+- lib/http_service.rb
+- lib/tusc.rb
+- lib/tusc/creation_request.rb
+- lib/tusc/creation_response.rb
+- lib/tusc/offset_request.rb
+- lib/tusc/offset_response.rb
+- lib/tusc/responsorial.rb
+- lib/tusc/upload_request.rb
+- lib/tusc/upload_response.rb
+- lib/tusc/uploader.rb
+- lib/tusc/version.rb
+- tusc.gemspec
+homepage: https://github.com/mattscilipoti/tusc.rb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/mattscilipoti/tusc.rb
+  source_code_uri: https://github.com/mattscilipoti/tusc.rb
+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.1.2
+signing_key:
+specification_version: 4
+summary: 'Ruby client for [tus](https://tus.io/): open protocol for resumable file
+  uploads'
+test_files: []