rack-raw-upload - GitLite

KO | EN

gitlite — search

#javascript #go #golang #android #macos #java #windows #awesome #kubernetes #vue #pytorch #security #mcp #ios

rack-raw-upload

(★ 99)

Rack middleware to handle raw file uploads

파일 탐색기

최종 버전 다운로드 (.zip)

- - raw_upload.rb
- rack-raw-upload.rb
- - me-in-shanghai.jpg
- raw_upload_test.rb
.gitignore
.travis.yml
Gemfile
Gemfile.lock
LICENSE
rack-raw-upload.gemspec
Rakefile
README.md

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/New-Bamboo/rack-raw-upload

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd rack-raw-upload

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Ruby

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Ruby bundle 명령어를 쓰려면 Ruby가 필요합니다.

bundle install

Gemfile에 명시된 루비 라이브러리를 설치합니다.

✅ bundle install이 에러 없이 끝나면 README에 안내된 실행 명령어(예: rails server)로 마저 실행해보세요.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# WARNING: you may not need this

If you want to use this because you are performing HTML5 file uploads, you may be doing it [the "old way"](http://blog.new-bamboo.co.uk/2010/7/30/html5-powered-ajax-file-uploads).

There is a "new", [better way of doing this](http://blog.new-bamboo.co.uk/2012/01/10/ridiculously-simple-ajax-uploads-with-formdata). It may be a better solution for your problems.

However, if this is not the case, please read on. I hope you find this middleware useful.

# WARNING: there seem to be problems running this on Windows

I have received reports of this middleware not working properly on Windows environments. Unfortunately, I am not able to fix this. If you encounter such problems and are able to provide a fix with a test case, I'll be delighted to include it in a future version of this software.

# Rack Raw Upload middleware

Rack::RawUpload converts raw uploads into normal multipart requests, like those in a form. Rack applications can then read these as normal (using `params` for example), rather than from `env['rack.input']` or similar.

## Assumptions

Rack::RawUpload performs this conversion when all these conditions are met:

1. The request method is POST or PUT
2. The mimetype is NOT one of
    * `application/x-www-form-urlencoded`
    * `multipart/form-data`
3. The Content-Length is greater than 0

## Configuration

### Bog-standard Rack app

The simpler case. Add these lines in your `config.ru`, where appropriate:

require 'rack/raw_upload'
    use Rack::RawUpload

If you want to limit the conversion to a few known paths, do:

require 'rack/raw_upload'
    use Rack::RawUpload, :paths => ['/upload/path', '/alternative/path.*']

You can also make it so that the conversion only happens when explicitly required by the client using a header. This would be `X-File-Upload: true` to make the conversion regardless of the content type. A value of `X-File-Upload: smart` would ask for the normal detection to be performed. For this, use the following setting:

use Rack::RawUpload, :explicit => true

### Ruby on Rails

Add this to your Gemfile

gem 'rack-raw-upload'

and then add the middleware in application.rb

config.middleware.use Rack::RawUpload

## Usage

The upload is made into a request argument called `file`. In several popular frameworks, this can be accessed as `params[:file]`. This includes Rails and Sinatra, but may be different in other frameworks.

## Optional request headers

Raw uploads, due to their own nature, can't provide additional arguments in the request. This limitation can be worked around using headers.

* `X-File-Name`: specify the name of the uploaded file.
* `X-File-Upload`: explicitly tells whether to perform the conversion or not. Possible values are 'true' (string), 'false' (string) or 'smart'. Default is 'smart', unless the middleware is initialized with `:explicit => true`, in which case default is 'false'.
* `X-Params`: query string with additional arguments. On Rails or Sinatra, you can read these as `params[:name_of_argument]`.
* `X-JSON-Params`: same thing, but in the form of a JSON string.
* `X-Query-Params`: **deprecated**. Equivalent to `X-JSON-Params`. Will be removed in future versions.

## Additional info

A blog post on Ajax uploads. These are raw uploads and can be greatly simplified with this middleware:

* [http://blog.new-bamboo.co.uk/2010/7/30/html5-powered-ajax-file-uploads](http://blog.new-bamboo.co.uk/2010/7/30/html5-powered-ajax-file-uploads)

This middleware should work with Ruby 1.8.7, 1.9.2, 1.9.3, REE, Rubinius and JRuby. Tests for all these platforms are run on the wonderful [Travis-CI](http://travis-ci.org/) regularly, and the current status of these is: [![Build Status](https://api.travis-ci.org/newbamboo/rack-raw-upload.png)](http://travis-ci.org/newbamboo/rack-raw-upload)