rubytus 0.1.0

data/.editorconfig

@@ -0,0 +1,10 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+tus_data

data/.simplecov

@@ -0,0 +1,6 @@
+SimpleCov.start do
+  add_filter '/test/'
+  add_filter '/bin/'
+
+  add_group 'Libraries', 'lib'
+end

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+script: bundle exec rake test
+notifications:
+  email:
+    - subosito@gmail.com

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+MIT License
+
+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,57 @@
+# Rubytus
+
+Resumable upload protocol implementation in Ruby
+
+[![Build Status](https://travis-ci.org/picocandy/rubytus.png)](https://travis-ci.org/picocandy/rubytus)
+[![Coverage Status](https://coveralls.io/repos/picocandy/rubytus/badge.png?branch=master)](https://coveralls.io/r/picocandy/rubytus?branch=master)
+
+## Installation
+
+```bash
+$ gem install rubytus
+```
+
+## Usage
+
+```
+$ rubytusd --help
+Usage: <server> [options]
+
+Server options:
+    -e, --environment NAME           Set the execution environment (default: development)
+    -a, --address HOST               Bind to HOST address (default: 0.0.0.0)
+    -p, --port PORT                  Use PORT (default: 9000)
+    -S, --socket FILE                Bind to unix domain socket
+
+Daemon options:
+    -u, --user USER                  Run as specified user
+    -c, --config FILE                Config file (default: ./config/<server>.rb)
+    -d, --daemonize                  Run daemonized in the background (default: false)
+    -l, --log FILE                   Log to file (default: off)
+    -s, --stdout                     Log to stdout (default: false)
+    -P, --pid FILE                   Pid file (default: off)
+
+SSL options:
+        --ssl                        Enables SSL (default: off)
+        --ssl-key FILE               Path to private key
+        --ssl-cert FILE              Path to certificate
+        --ssl-verify                 Enables SSL certificate verification
+
+Common options:
+    -C, --console                    Start a console
+    -v, --verbose                    Enable verbose logging (default: false)
+    -h, --help                       Display help message
+
+TUSD options:
+    -f, --data-dir DATA_DIR          Directory to store uploaded and partial files (default: tus_data)
+    -b, --base-path BASE_PATH        Url path used for handling uploads (default: /files/)
+    -m, --max-size MAX_SIZE          How many bytes may be stored inside DATA_DIR (default: 1073741824)
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/test*']
+end
+
+desc 'Run tests'
+task :default => :test

data/bin/rubytusd

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require 'pathname'
+bin = Pathname.new(__FILE__).realpath
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', bin)
+ENV['RACK_ENV'] ||= ENV['TUSD_ENV'] || 'development'
+
+require 'bundler'
+Bundler.setup
+Bundler.require(:default)
+
+require 'rubytus/command'

data/lib/rubytus.rb

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

data/lib/rubytus/api.rb

@@ -0,0 +1,79 @@
+require 'goliath'
+require 'goliath/constants'
+require 'rubytus/constants'
+require 'rubytus/request'
+require 'rubytus/helpers'
+require 'rubytus/error'
+require 'stringio'
+
+module Rubytus
+  class API < Goliath::API
+    include Goliath::Constants
+    include Rubytus::Constants
+    include Rubytus::Helpers
+
+    def on_headers(env, headers)
+      env['api.options'] = @options
+      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
+        env['api.buffers'] << data
+      else
+        body = StringIO.new(data)
+        env[RACK_INPUT] = body
+      end
+    end
+
+    def response(env)
+      status  = STATUS_OK
+      headers = env['api.headers']
+      body    = []
+
+      [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
+
+    def default_options
+      {
+        :base_path => ENV[ENV_BASE_PATH] || DEFAULT_BASE_PATH,
+        :max_size  => ENV[ENV_MAX_SIZE]  || DEFAULT_MAX_SIZE
+      }
+    end
+
+    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
+      end
+
+      # save into global options
+      @options = options
+    end
+  end
+end

data/lib/rubytus/command.rb

@@ -0,0 +1,72 @@
+require 'rubytus/api'
+require 'rubytus/request'
+require 'rubytus/error'
+require 'rubytus/storage'
+require 'rubytus/middlewares/tus_barrier'
+require 'rubytus/middlewares/storage_barrier'
+
+module Rubytus
+  class Command < API
+    include Constants
+    include StorageHelper
+
+    use Middlewares::TusBarrier
+    use Middlewares::StorageBarrier
+
+    def on_headers(env, headers)
+      super(env, headers)
+
+      request = 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 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] = validates_data_dir(@options[:data_dir])
+        @options[:storage]  = Storage.new(@options)
+      rescue PermissionError, ConfigurationError => e
+        puts '[ERROR] ' + e.message
+        exit(1)
+      end
+    end
+
+    private
+    def storage
+      @options[:storage]
+    end
+  end
+end

data/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

data/lib/rubytus/constants.rb

@@ -0,0 +1,33 @@
+module Rubytus
+  module Constants
+    RESOURCE_UID_REGEX     = /^([a-z0-9]{32})$/
+    BASE_PATH_REGEX        = /^(\/[a-zA-Z0-9\-_]+\/)$/
+
+    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
+
+    STATUS_OK              = 200
+    STATUS_CREATED         = 201
+    STATUS_BAD_REQUEST     = 400
+    STATUS_FORBIDDEN       = 403
+    STATUS_NOT_FOUND       = 404
+    STATUS_NOT_ALLOWED     = 405
+    STATUS_INTERNAL_ERROR  = 500
+
+    COMMON_HEADERS         = {
+      'Access-Control-Allow-Origin'   => '*',
+      'Access-Control-Allow-Methods'  => 'HEAD,GET,PUT,POST,PATCH,DELETE',
+      'Access-Control-Allow-Headers'  => 'Origin, X-Requested-With, Content-Type, Accept, Content-Disposition, Final-Length, Offset',
+      'Access-Control-Expose-Headers' => 'Location, Range, Content-Disposition, Offset'
+    }
+  end
+end

data/lib/rubytus/error.rb

@@ -0,0 +1,4 @@
+module Rubytus
+  class ConfigurationError < StandardError; end
+  class PermissionError < StandardError; end
+end

data/lib/rubytus/helpers.rb

@@ -0,0 +1,82 @@
+require 'rubytus/constants'
+require 'rubytus/common'
+require 'rubytus/error'
+
+module Rubytus
+  module Helpers
+    include Rubytus::Constants
+    include Rubytus::Common
+
+    def prepare_headers(env, headers)
+      request = Rubytus::Request.new(env)
+
+      # CREATE
+      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?
+        # UID for this resource
+        env['api.uid'] = request.resource_uid
+
+        # HEAD
+        if request.head?
+          env['api.action'] = :head
+        end
+
+        # PATCH
+        if request.patch?
+          unless request.resumable_content_type?
+            error!(STATUS_BAD_REQUEST, "Content-Type must be '#{RESUMABLE_CONTENT_TYPE}'")
+          end
+
+          env['api.action']  = :patch
+          env['api.buffers'] = ''
+          env['api.offset']  = request.offset
+        end
+
+        # GET
+        if request.get?
+          env['api.action'] = :get
+        end
+      end
+    end
+
+    def validates_offset(req_offset, info_offset)
+      if req_offset > info_offset
+        error!(STATUS_FORBIDDEN, "Offset: #{req_offset} exceeds current offset: #{info_offset}")
+      end
+    end
+
+    def validates_length(req_length, remaining)
+      if req_length > remaining
+        error!(STATUS_FORBIDDEN, "Content-Length: #{req_length} exceeded remaining length: #{remaining}")
+      end
+    end
+
+    def validates_base_path(base_path)
+      unless base_path =~ BASE_PATH_REGEX
+        raise ConfigurationError, "Invalid `base_path` configuration, it should be using format /uploads/, /user-data/, etc"
+      end
+
+      base_path
+    end
+
+    def validates_max_size(max_size)
+      if max_size.is_a? String
+        max_size = max_size.to_i
+      end
+
+      if max_size <= 0
+        raise ConfigurationError, "Invalid `max_size`, it should be > 0 bytes"
+      end
+
+      max_size
+    end
+  end
+end