picocandy/rubytus

Resumable upload protocol implementation in Ruby

Rubytus

Resumable upload protocol implementation in Ruby

Installation

$ 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

rubytus's Issues

Compatibility with tus 1.0

tus 1.0 is just around the corner. I would be pleased to see this implementation being updated to support the next version. Most updates are outside the core so only minimal changes are required to maintain comparability. You can find detailed information or get feedback at the according issue tus/tus-resumable-upload-protocol#57.

Rails integration

Are there any examples or documentation on how this would integrate with a rails application?

Question: Why does Rubytus use Goliath?

First of all, thank you for sharing this with the world, it was very inspirational to dive into the source code.

But I'm curious, why does Rubytus use Goliath instead of a regular synchronous framework? I feel like using EventMachine is awesome when you're doing a lot of IO (e.g. HTTP requests), because then everything is asynchronous. But Rubytus only writes to filesystem, which is very fast. And even if it's not, it's currently still synchronous.

So just out of curiosity I wanted to know why did you decide to use Goliath? Is it because of its ability to terminate the request before the request body is received?

behind proxy feature request

We were trying to run tus-ruby-server behind a reverse proxy via SSL and noticed that rubytus doesn’t have the “behind proxy” feature yet. Would you be able to add this feature considering the importance of SSL?