split the storage to support extensions

Author: subosito

.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+tus_data

bin/rubytusd

@@ -11,4 +11,95 @@ Bundler.setup
 Bundler.require(:default)
 
 require 'rubytus/api'
+require 'rubytus/error'
+require 'rubytus/storage'
+require 'rubytus/middlewares/tus_barrier'
+require 'rubytus/middlewares/storage_barrier'
+
+class API < Rubytus::API
+  include Rubytus::Constants
+
+  use Rubytus::Middlewares::TusBarrier
+  use Rubytus::Middlewares::StorageBarrier
+
+  def on_headers(env, headers)
+    super(env, headers)
+
+    request = Rubytus::Request.new(env)
+
+    begin
+
+      if env['api.action'] == :patch
+        uid  = env['api.uid']
+        info = storage.read_info(uid)
+
+        validates_offset(request.offset, info.offset)
+        validates_length(request.content_length, info.remaining_length)
+      end
+
+    rescue Rubytus::PermissionError => e
+      error!(STATUS_INTERNAL_ERROR, e.message)
+    end
+  end
+
+  def on_close(env)
+    if env['api.action'] == :patch
+      storage.patch_file(env['api.uid'], env['api.buffers'], env['api.offset'])
+    end
+  end
+
+  def options_parser(opts, options)
+    options = init_options.merge(options)
+    default_parser(opts, options)
+    opts.on('-f', '--data-dir DATA_DIR', "Directory to store uploads, LOCAL storage only (default: #{options[:data_dir]})") do |value|
+      options[:data_dir] = value
+    end
+  end
+
+  def init_options
+    options = default_options
+    options[:data_dir] = ENV[ENV_DATA_DIR] || DEFAULT_DATA_DIR
+    options
+  end
+
+  def setup
+    begin
+      default_setup
+      @options[:data_dir] = validate_data_dir(@options[:data_dir])
+      @options[:storage]  = Rubytus::Storage.new(@options)
+    rescue Rubytus::PermissionError, Rubytus::ConfigurationError => e
+      puts '[ERROR] ' + e.message
+      exit(1)
+    end
+  end
+
+  private
+  def storage
+    @options[:storage]
+  end
+
+  def validate_data_dir(data_dir)
+    if Pathname.new(data_dir).relative?
+      data_dir = File.join(ENV['PWD'], data_dir)
+    end
+
+    begin
+      unless File.directory?(data_dir)
+        Dir.mkdir(data_dir)
+      end
+    rescue SystemCallError => _
+      raise Rubytus::PermissionError, "Couldn't create `data_dir` in #{data_dir}"
+    end
+
+    unless File.world_writable?(data_dir)
+      begin
+        File.chmod(0777, data_dir)
+      rescue Errno::EPERM
+        raise Rubytus::PermissionError, "Couldn't make `data_dir` in #{data_dir} writable"
+      end
+    end
+
+    data_dir
+  end
+end
 

lib/rubytus.rb

@@ -1,4 +1,3 @@
 require 'rubytus/version'
 
-module Rubytus
-end
+module Rubytus; end

lib/rubytus/api.rb

@@ -1,11 +1,9 @@
 require 'goliath'
 require 'goliath/constants'
-require 'rubytus/error'
-require 'rubytus/helpers'
-require 'rubytus/request'
-require 'rubytus/storage'
 require 'rubytus/constants'
-require 'rubytus/rack/handler'
+require 'rubytus/request'
+require 'rubytus/helpers'
+require 'rubytus/error'
 require 'stringio'
 
 module Rubytus
@@ -14,109 +12,68 @@ class API < Goliath::API
     include Rubytus::Constants
     include Rubytus::Helpers
 
-    use Rubytus::Rack::Handler
-
     def on_headers(env, headers)
-      request = Rubytus::Request.new(env)
-
       env['api.options'] = @options
-      env['api.headers'] = COMMON_HEADERS.merge({
-        'Date' => Time.now.httpdate
-      })
-
-      begin
-        if request.collection? && request.post?
-          uid = generate_uid
-
-          env['api.action']       = :create
-          env['api.uid']          = uid
-          env['api.final_length'] = request.final_length
-          env['api.resource_url'] = request.resource_url(uid)
-        end
-
-        if request.resource? && request.head?
-          env['api.action'] = :head
-          env['api.uid']    = request.resource_uid
-        end
-
-        if request.resource? && request.patch?
-          unless request.resumable_content_type?
-            raise HeaderError, "Content-Type must be '#{RESUMABLE_CONTENT_TYPE}'"
-          end
-
-          uid  = request.resource_uid
-          info = storage.read_info(uid)
-
-          if request.offset > info.offset
-            raise UploadError, "Offset: #{request.offset} exceeds current offset: #{info.offset}"
-          end
-
-          if request.content_length > info.remaining_length
-            raise UploadError, "Content-Length: #{request.content_length} exceeded remaining length: #{info.remaining_length}"
-          end
-
-          env['api.action'] = :patch
-          env['api.uid']    = uid
-          env['api.file']   = storage.open_file(uid, request.offset)
-        end
-
-        if request.resource? && request.get?
-          env['api.action'] = :get
-          env['api.uid']    = request.resource_uid
-        end
-
-      rescue HeaderError => e
-        raise Goliath::Validation::Error.new(STATUS_BAD_REQUEST, e.message)
-
-      rescue UploadError => e
-        raise Goliath::Validation::Error.new(STATUS_FORBIDDEN, e.message)
-      end
+      env['api.headers'] = COMMON_HEADERS.merge({ 'Date' => Time.now.httpdate })
+      prepare_headers(env, headers)
     end
 
     def on_body(env, data)
       if env['api.action'] == :patch
-        storage.patch_file(env['api.file'], data)
+        env['api.buffers'] << data
       else
         body = StringIO.new(data)
         env[RACK_INPUT] = body
       end
     end
 
-    def on_close(env)
-      file = env['api.file']
-
-      if file
-        size = file.size
-        file.close unless file.closed?
-        storage.update_info(env['api.uid'], size)
-      end
-    end
-
     def response(env)
       status  = STATUS_OK
       headers = env['api.headers']
-      action  = env['api.action']
       body    = []
 
-      begin
-        case action
-        when :create
-          status = STATUS_CREATED
-          headers['Location'] = env['api.resource_url']
-          storage.create_file(env['api.uid'], env['api.final_length'])
+      [status, headers, body]
+    end
+
+    def default_setup
+      @options[:max_size]  = validates_max_size(@options[:max_size])
+      @options[:base_path] = validates_base_path(@options[:base_path])
+    end
 
-        when :head
-          info = storage.read_info(env['api.uid'])
-          headers['Offset'] = info.offset.to_s
+    def default_options
+      {
+        :base_path => ENV[ENV_BASE_PATH] || DEFAULT_BASE_PATH,
+        :max_size  => ENV[ENV_MAX_SIZE]  || DEFAULT_MAX_SIZE
+      }
+    end
 
-        when :get
-          body = storage.read_file(env['api.uid'])
+    def default_parser(opts, options)
+      opts.separator ""
+      opts.separator "TUSD options:"
+
+      args = [
+        {
+          :name  => :base_path,
+          :short => '-b',
+          :long  => '--base-path BASE_PATH',
+          :desc  => "Url path used for handling uploads (default: #{options[:base_path]})"
+        },
+        {
+          :name  => :max_size,
+          :short => '-m',
+          :long  => '--max-size MAX_SIZE',
+          :desc  => "Maximum bytes may be stored inside storage (default: #{options[:max_size]})"
+        }
+      ]
+
+      args.each do |arg|
+        opts.on(arg[:short], arg[:long], arg[:desc]) do |value|
+          options[arg[:name]] = value
         end
-      rescue PermissionError => e
-        raise Goliath::Validation::Error.new(500, e.message)
       end
 
-      [status, headers, body]
+      # save into global options
+      @options = options
     end
   end
 end

lib/rubytus/common.rb

@@ -0,0 +1,11 @@
+module Rubytus
+  module Common
+    def generate_uid
+      SecureRandom.hex(16)
+    end
+
+    def error!(status, message)
+      raise Goliath::Validation::Error.new(status, message)
+    end
+  end
+end

lib/rubytus/constants.rb

@@ -5,10 +5,12 @@ module Constants
 
     RESUMABLE_CONTENT_TYPE = 'application/offset+octet-stream'
 
+    ENV_STORAGE            = 'TUSD_STORAGE'
     ENV_DATA_DIR           = 'TUSD_DATA_DIR'
     ENV_BASE_PATH          = 'TUSD_BASE_PATH'
     ENV_MAX_SIZE           = 'TUSD_MAX_SIZE'
 
+    DEFAULT_STORAGE        = 'local'
     DEFAULT_DATA_DIR       = 'tus_data'
     DEFAULT_BASE_PATH      = '/files/'
     DEFAULT_MAX_SIZE       = 1073741824

lib/rubytus/error.rb

@@ -1,6 +1,4 @@
 module Rubytus
   class ConfigurationError < StandardError; end
   class PermissionError < StandardError; end
-  class HeaderError < StandardError; end
-  class UploadError < StandardError; end
 end