rack-raw-upload 1.0.9 → 1.0.10

data/README.md

@@ -1,21 +1,18 @@
 # Rack Raw Upload middleware
 
-Rack::RawUpload converts raw file uploads into normal form input, so Rack applications can read these as normal (using `params` for example), rather than from `env['rack.input']` or similar.
+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.
 
-Rack::RawUpload know that a request is such an upload when the mimetype **is not** one of the following:
-
-* application/x-www-form-urlencoded
-* multipart/form-data
-
-Additionally, it can be told explicitly to perform the conversion, using the header `X-File-Upload`. See below for details.
+Rack::RawUpload processes a request this way when the mimetype **is not** one of the following:
 
 ## Assumptions
 
-Rack::RawUpload expects that requests will:
-
-1. be POST or PUT requests
-2. set the mimetype `application/octet-stream`
+Rack::RawUpload performs this conversion when all these conditions are met:
 
+1. The request method is POST or PUT
+2. The mimetype is one of
+    * application/x-www-form-urlencoded
+    * multipart/form-data
+3. The request includes body data
 
 ## Configuration
 
@@ -45,24 +42,24 @@ and then add the middleware in application.rb
 
     config.middleware.use 'Rack::RawUpload'
 
-## More options
 
-### Specifying the file name of the upload
+## 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.
 
-Raw uploads, due to their own nature, don't include the name of the file being uploaded. You can work around this limitation by specifying the filename as an HTTP header.
 
-When present, Rack::RawUpload will assume that the header ***`X-File-Name`*** will contain the filename.
+## Optional request headers
 
-### Additional query parameters
+Raw uploads, due to their own nature, can't provide additional arguments in the request. This limitation can be worked around using headers.
 
-Again, the nature of raw uploads prevents us from sending additional parameters along with the file. As a workaround, you can specify there as a header too. They will be made available as normal parameters.
+* `X-File-Name`: specify the name of the uploaded file.
+* `X-Query-Params`: JSON-formatted hash containing additional arguments. On Rails or Sinatra, you can read these as `params[:name_of_argument]`
 
-When present, Rack::RawUpload will assume that the header ***`X-Query-Params`*** contains these additional parameters. The values are expected to be in the form of a **JSON** hash.
 
 ## Additional info
 
-A blog post on HTML5 uploads, which are raw uploads, and can be greatly simplified with this middleware:
+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, 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](http://travis-ci.org/newbamboo/rack-raw-upload.png)](http://travis-ci.org/newbamboo/rack-raw-upload)
+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](http://travis-ci.org/newbamboo/rack-raw-upload.png)](http://travis-ci.org/newbamboo/rack-raw-upload)

data/lib/rack/raw_upload.rb

@@ -3,7 +3,7 @@ require 'tmpdir' # Needed in 1.8.7 to access Dir::tmpdir
 module Rack
   class RawUpload
 
-    VERSION = '1.0.9'
+    VERSION = '1.0.10'
 
     def initialize(app, opts = {})
       @app = app
@@ -75,7 +75,8 @@ module Rack
     def raw_file_upload?(env)
       upload_path?(env['PATH_INFO']) &&
         %{POST PUT}.include?(env['REQUEST_METHOD']) &&
-        content_type_of_raw_file?(env['CONTENT_TYPE'])
+        content_type_of_raw_file?(env['CONTENT_TYPE']) &&
+        input_is_present?(env['rack.input'])
     end
 
     def literal_path_match?(request_path, candidate)
@@ -97,6 +98,10 @@ module Rack
       end
     end
 
+    def input_is_present?(input)
+      !input.nil? && (!input.respond_to?(:empty?) || !input.empty?)
+    end
+
     def random_string
       (0...8).map{65.+(rand(25)).chr}.join
     end

data/test/raw_upload_test.rb

@@ -73,6 +73,11 @@ class RawUploadTest < Test::Unit::TestCase
       assert_successful_non_upload
     end
 
+    should "not work when there is no input" do
+      upload('rack.input' => '')
+      assert_successful_non_upload
+    end
+
     # "stuff" should be something like "boundary=----WebKitFormBoundaryeKPeU4p65YgercgO",
     # but if I do that here, Rack tries to be clever and the test breaks
     should "not work with Content-Type 'multipart/form-data; stuff'" do

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rack-raw-upload
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 3
+  prerelease: 
   segments: 
   - 1
   - 0
-  - 9
-  version: 1.0.9
+  - 10
+  version: 1.0.10
 platform: ruby
 authors: 
 - Pablo Brasero
@@ -14,16 +15,17 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-24 00:00:00 +01:00
-default_executable: 
+date: 2011-11-23 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: json
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -33,9 +35,11 @@ dependencies:
   name: rake
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -45,9 +49,11 @@ dependencies:
   name: rack-test
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -57,9 +63,11 @@ dependencies:
   name: shoulda
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -101,7 +109,6 @@ files:
 - README.md
 - Gemfile
 - Gemfile.lock
-has_rdoc: true
 homepage: https://github.com/newbamboo/rack-raw-upload
 licenses: []
 
@@ -113,26 +120,31 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Rack Raw Upload middleware
 test_files: 
 - test/apps/undefined_conversion_error/app/controllers/test_controller.rb
 - test/apps/undefined_conversion_error/test/test_helper.rb
+has_rdoc: