tusc 0.6.1

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "tusc"
+
+# 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/rackup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rackup' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rack", "rackup")

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

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/config.ru

@@ -0,0 +1,8 @@
+# tus server for testing
+# start via $ `rackup`
+# see: https://github.com/janko/tus-ruby-server
+require 'tus/server'
+
+map '/files' do
+  run Tus::Server
+end

data/lib/core_ext/object/blank.rb

@@ -0,0 +1,144 @@
+# File activesupport/lib/active_support/core_ext/object/blank.rb, line 122
+class Object
+  # An object is blank if it's false, empty, or a whitespace string.
+  # For example, +false+, '', '   ', +nil+, [], and {} are all blank.
+  #
+  # This simplifies
+  #
+  #   !address || address.empty?
+  #
+  # to
+  #
+  #   address.blank?
+  #
+  # @return [true, false]
+  def blank?
+    respond_to?(:empty?) ? !!empty? : !self
+  end
+
+  # An object is present if it's not blank.
+  #
+  # @return [true, false]
+  def present?
+    !blank?
+  end
+
+  # Returns the receiver if it's present otherwise returns +nil+.
+  # <tt>object.presence</tt> is equivalent to
+  #
+  #    object.present? ? object : nil
+  #
+  # For example, something like
+  #
+  #   state   = params[:state]   if params[:state].present?
+  #   country = params[:country] if params[:country].present?
+  #   region  = state || country || 'US'
+  #
+  # becomes
+  #
+  #   region = params[:state].presence || params[:country].presence || 'US'
+  #
+  # @return [Object]
+  def presence
+    self if present?
+  end
+end
+
+class NilClass
+  # +nil+ is blank:
+  #
+  #   nil.blank? # => true
+  #
+  # @return [true]
+  def blank?
+    true
+  end
+end
+
+class FalseClass
+  # +false+ is blank:
+  #
+  #   false.blank? # => true
+  #
+  # @return [true]
+  def blank?
+    true
+  end
+end
+
+class TrueClass
+  # +true+ is not blank:
+  #
+  #   true.blank? # => false
+  #
+  # @return [false]
+  def blank?
+    false
+  end
+end
+
+class Array
+  # An array is blank if it's empty:
+  #
+  #   [].blank?      # => true
+  #   [1,2,3].blank? # => false
+  #
+  # @return [true, false]
+  alias blank? empty?
+end
+
+class Hash
+  # A hash is blank if it's empty:
+  #
+  #   {}.blank?                # => true
+  #   { key: 'value' }.blank?  # => false
+  #
+  # @return [true, false]
+  alias blank? empty?
+end
+
+class String
+  BLANK_RE = /\A[[:space:]]*\z/.freeze unless defined? BLANK_RE # rails may be loaded by client
+
+  # A string is blank if it's empty or contains whitespaces only:
+  #
+  #   ''.blank?       # => true
+  #   '   '.blank?    # => true
+  #   "\t\n\r".blank? # => true
+  #   ' blah '.blank? # => false
+  #
+  # Unicode whitespace is supported:
+  #
+  #   "\u00a0".blank? # => true
+  #
+  # @return [true, false]
+  def blank?
+    # The regexp that matches blank strings is expensive. For the case of empty
+    # strings we can speed up this method (~3.5x) with an empty? call. The
+    # penalty for the rest of strings is marginal.
+    empty? || BLANK_RE === self
+  end
+end
+
+class Numeric #:nodoc:
+  # No number is blank:
+  #
+  #   1.blank? # => false
+  #   0.blank? # => false
+  #
+  # @return [false]
+  def blank?
+    false
+  end
+end
+
+class Time #:nodoc:
+  # No Time is blank:
+  #
+  #   Time.now.blank? # => false
+  #
+  # @return [false]
+  def blank?
+    false
+  end
+end

data/lib/core_ext/string/truncate.rb

@@ -0,0 +1,44 @@
+class String
+  def truncate(maximum_length, omission: '…', mode: :right)
+    case mode
+    when :right, 'right'
+      truncate_right(maximum_length, omission: omission)
+    when :middle, 'middle'
+      truncate_middle(maximum_length, omission)
+    else
+      raise ArgumentError, "Unsupported mode (#{mode}), expected [:middle, :right]."
+    end
+  end
+
+  # File activesupport/lib/active_support/core_ext/string/filters.rb, line 66
+  def truncate_right(truncate_at, options = {})
+    return dup unless length > truncate_at
+
+    omission = options[:omission] || '…'
+    length_with_room_for_omission = truncate_at - omission.length
+    stop = if options[:separator]
+             rindex(options[:separator], length_with_room_for_omission) || length_with_room_for_omission
+           else
+             length_with_room_for_omission
+      end
+
+    +"#{self[0, stop]}#{omission}"
+  end
+
+  # Truncates the middle, leaving portions from start & end
+  # see https://stackoverflow.com/a/62713671
+  def truncate_middle(maximum_length = 3, separator = '…')
+    return '' if maximum_length.zero?
+    return self if length <= maximum_length
+
+    middle_length = length - maximum_length + separator.length
+    edges_length = (length - middle_length) / 2.0
+    left_length = edges_length.ceil
+    right_length = edges_length.floor
+
+    left_string = left_length.zero? ? '' : self[0, left_length]
+    right_string = right_length.zero? ? '' : self[-right_length, right_length]
+
+    "#{left_string}#{separator}#{right_string}"
+  end
+end

data/lib/http_service.rb

@@ -0,0 +1,87 @@
+require 'digest'
+require 'net/http'
+require_relative 'core_ext/string/truncate'
+
+# Provides basic http calls (head, patch, post), with detailed logging
+class TusClient::HttpService
+  def self.head(uri:, headers:, logger:)
+    request = Net::HTTP::Head.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
+    _perform(http_request: request, logger: logger)
+  end
+
+  def self.post(uri:, headers:, body: nil, logger:)
+    request = Net::HTTP::Post.new(uri, headers)
+    request.body = body
+    _perform(http_request: request, logger: logger)
+  end
+
+  def self._log_request(http_request, logger)
+    logger.info do
+      uri = http_request.uri
+
+      header_info = {}
+      http_request.each_header do |key, value|
+        header_info[key] = value
+      end
+
+      request_info = { uri: uri.to_s, header: header_info }
+
+      request_body = http_request.body.to_s
+      request_info[:body_md5] = Digest::MD5.hexdigest(request_body) unless request_body.blank?
+      request_info[:body_size] = request_body.size unless request_body.blank?
+
+      formatted_body =  case request_body.encoding
+                        when Encoding::ASCII_8BIT
+                          request_body.encoding.inspect
+                        else
+                          request_body.truncate_middle(60)
+                        end
+      request_info[:body] = formatted_body
+
+      [ "TUS #{http_request.method}",
+        { request: request_info },
+        TusClient.log_info,
+      ]
+    end
+  end
+
+  def self._log_response(http_method, http_response, logger)
+    header_info = {}
+    http_response.each_header do |key, value|
+      header_info[key] = value
+    end
+
+    logger.info do
+      [ "TUS #{http_method}",
+        { response: {
+         status: http_response.code,
+         header: header_info,
+         body: http_response.body.to_s.truncate_middle(60)
+        }},
+        TusClient.log_info,
+      ]
+    end
+  end
+
+  def self._perform(http_request:, logger:)
+    _log_request(http_request, logger)
+
+    uri = http_request.uri
+    http_response = Net::HTTP.start(
+      uri.host,
+      uri.port,
+      use_ssl: uri.scheme == 'https'
+    ) do |http|
+      http.request http_request
+    end
+
+    _log_response(http_request.method, http_response, logger)
+    http_response
+  end
+end

data/lib/tusc.rb

@@ -0,0 +1,56 @@
+require 'logger'
+require 'tusc/version'
+require_relative 'core_ext/object/blank'
+require_relative 'tusc/creation_request'
+require_relative 'tusc/uploader'
+
+class Logger::LogDevice
+  # MonkeyPatch: to disable log header
+  def add_log_header(file); end
+end
+
+module TusClient
+  KILOBYTE = 1024
+  MEGABYTE = KILOBYTE * 1024
+
+  class Error < StandardError; end
+
+  def self.log_dir
+    log_dir = Pathname.new(File.expand_path('./log'))
+    Dir.mkdir(log_dir) unless Dir.exist?(log_dir)
+    log_dir
+  end
+
+  def self.log_info
+    # find first entry in under the tusc dir
+    # source should be tus code, not support code
+    source = caller_locations.find { |entry| entry.to_s =~ %r{/tusc/} }.to_s
+    # method_name = (source =~ /`([^']*)'/ and Regexp.last_match(1)).to_s
+    {
+      source: source,
+      # method: method_name,
+    }
+  end
+
+  def self.log_level
+    @log_level ||= Logger::INFO
+  end
+
+  def self.log_level=(value)
+    @logger = nil # invalidate cache
+    @log_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
+      end
+    end
+  end
+
+  def self.logger=(value)
+    @logger = value
+  end
+end

data/lib/tusc/creation_request.rb

@@ -0,0 +1,45 @@
+require_relative '../http_service'
+require_relative 'creation_response'
+
+# Sends the creation request to the tus server
+class TusClient::CreationRequest
+  attr_reader :body, :extra_headers, :file_size, :tus_creation_url
+  def initialize(tus_creation_url:, file_size:, extra_headers: {}, body: nil)
+    @tus_creation_url = tus_creation_url
+    @file_size = file_size
+    @extra_headers = extra_headers
+    @body = body
+  end
+
+  def headers
+    {
+      'Content-Length' => 0.to_s,
+      'Tus-Resumable' => supported_tus_resumable_versions.first,
+      'Upload-Length' => file_size.to_s
+    }.merge(extra_headers)
+  end
+
+  def logger
+    @logger ||= TusClient.logger
+  end
+
+  # Sends the creation request to the tus server
+  # returns an upload_url (in CreationResponse)
+  def perform
+    response = TusClient::HttpService.post(
+      uri: tus_creation_uri,
+      headers: headers,
+      body: body,
+      logger: logger
+    )
+    TusClient::CreationResponse.new(response)
+  end
+
+  def supported_tus_resumable_versions
+    ['1.0.0']
+  end
+
+  def tus_creation_uri
+    @tus_creation_uri ||= URI.parse(tus_creation_url)
+  end
+end