rack-raw-upload 1.0.11 → 1.1.1

data/Gemfile

@@ -1,9 +1,10 @@
 source :rubygems
 
-gem 'json'
+gem 'multi_json'
 
 group :development, :test do
   gem 'rake'
   gem 'rack-test'
   gem 'shoulda'
+  gem 'rr'
 end

data/Gemfile.lock

@@ -1,12 +1,12 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    json (1.4.6)
-    json (1.4.6-java)
+    multi_json (1.3.2)
     rack (1.2.1)
     rack-test (0.5.6)
       rack (>= 1.0)
     rake (0.8.7)
+    rr (1.0.4)
     shoulda (2.11.3)
 
 PLATFORMS
@@ -14,7 +14,8 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  json
+  multi_json
   rack-test
   rake
+  rr
   shoulda

data/README.md

@@ -1,17 +1,23 @@
+# 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.
+
 # 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.
 
-Rack::RawUpload processes a request this way when the mimetype **is not** one of the following:
-
 ## Assumptions
 
 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
+    * `application/x-www-form-urlencoded`
+    * `multipart/form-data`
 3. The Content-Length is greater than 0
 
 ## Configuration
@@ -53,7 +59,10 @@ The upload is made into a request argument called `file`. In several popular fra
 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-Query-Params`: JSON-formatted hash containing additional arguments. On Rails or Sinatra, you can read these as `params[:name_of_argument]`
+* `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

data/lib/rack/raw_upload.rb

@@ -1,9 +1,10 @@
 require 'tmpdir' # Needed in 1.8.7 to access Dir::tmpdir
+require 'multi_json'
 
 module Rack
   class RawUpload
 
-    VERSION = '1.0.11'
+    VERSION = '1.1.1'
 
     def initialize(app, opts = {})
       @app = app
@@ -43,6 +44,7 @@ module Rack
             tempfile << chunk
           end
         end
+        env['rack.input'].rewind
 
         tempfile.flush
         tempfile.rewind
@@ -57,11 +59,15 @@ module Rack
       env['rack.request.query_hash'] ||= {}
       env['rack.request.form_hash']['file'] = fake_file
       env['rack.request.query_hash']['file'] = fake_file
-      if query_params = env['HTTP_X_QUERY_PARAMS']
-        require 'json'
-        params = JSON.parse(query_params)
-        env['rack.request.form_hash'].merge!(params)
-        env['rack.request.query_hash'].merge!(params)
+      if env['HTTP_X_QUERY_PARAMS']
+        env['rack.errors'].puts("Warning! The header X-Query-Params is deprecated. Please use X-JSON-Params instead.")
+        inject_json_params!(env, env['HTTP_X_QUERY_PARAMS'])
+      end
+      if env['HTTP_X_JSON_PARAMS']
+        inject_json_params!(env, env['HTTP_X_JSON_PARAMS'])
+      end
+      if env['HTTP_X_PARAMS']
+        inject_query_params!(env, env['HTTP_X_PARAMS'])
       end
       @app.call(env)
     end
@@ -101,6 +107,18 @@ module Rack
     def random_string
       (0...8).map{65.+(rand(25)).chr}.join
     end
+
+    def inject_json_params!(env, params)
+      hsh = MultiJson.load(params)
+      env['rack.request.form_hash'].merge!(hsh)
+      env['rack.request.query_hash'].merge!(hsh)
+    end
+
+    def inject_query_params!(env, params)
+      hsh = Rack::Utils.parse_query(params)
+      env['rack.request.form_hash'].merge!(hsh)
+      env['rack.request.query_hash'].merge!(hsh)
+    end
   end
 
 

data/test/apps/example/app.rb

@@ -0,0 +1,4 @@
+APP_ROOT = File.dirname(File.expand_path(__FILE__))
+
+require 'rubygems'
+require 'simple_app'

data/test/apps/example/lib/simple_app.rb

@@ -0,0 +1,44 @@
+require 'pp'
+require 'sinatra/base'
+require 'multi_json'
+
+class SimpleApp < Sinatra::Base
+
+  set :root, APP_ROOT
+  set :static, true
+  set :public_folder, Proc.new{ File.join(root, 'public') }
+  set :upload_dir, Proc.new{ File.join(public_folder, 'uploads') }
+
+  configure do
+    FileUtils.mkdir_p(settings.upload_dir)
+  end
+
+  get '/' do
+    erb :index
+  end
+
+  post '/' do
+    content_type :json
+    dump = Rack::Utils.escape_html(PP.pp(params, ''))
+    download_url = file_url(store_file(params[:file]))
+    MultiJson.dump({
+      :dump => dump,
+      :download_url => download_url,
+    })
+  end
+
+
+  private
+
+  def store_file(file_param)
+    dirpath = Dir.mktmpdir(nil, settings.upload_dir)
+    filepath = File.join(dirpath, file_param[:filename])
+    FileUtils.mv(file_param[:tempfile], filepath)
+    filepath
+  end
+
+  def file_url(path)
+    path.gsub(Regexp.new('^' + settings.public_folder), '').tap{|x| pp x}
+  end
+
+end

data/test/raw_upload_test.rb

@@ -2,11 +2,13 @@ require 'rubygems'
 require 'rack/test'
 require 'shoulda'
 require 'rack-raw-upload'
-require 'json'
+require 'multi_json'
 require 'digest'
+require 'rr'
 
 class RawUploadTest < Test::Unit::TestCase
   include Rack::Test::Methods
+  include RR::Adapters::TestUnit
 
   def app
     opts = @middleware_opts
@@ -79,9 +81,7 @@ class RawUploadTest < Test::Unit::TestCase
     should "not work when there is no input" do
       upload('rack.input' => '')
       assert_successful_non_upload
-    end
 
-    should "not work when there is no input" do
       upload('rack.input' => StringIO.new(''))
       assert_successful_non_upload
     end
@@ -120,6 +120,11 @@ class RawUploadTest < Test::Unit::TestCase
       assert_successful_non_upload
     end
 
+    should "leave rack.input in a state readable by other middlewares" do
+      upload
+      assert !last_request.env['rack.input'].eof?, "rack.input should be rewind'd"
+    end
+
     context "when garbage collection runs (Ruby 1.9)" do
       context "and the file is received as a Tempfile" do
         should "ensure that the uploaded file remains" do
@@ -196,9 +201,9 @@ class RawUploadTest < Test::Unit::TestCase
       end
     end
 
-    context "with query parameters" do
+    context "with JSON parameters" do
       setup do
-        upload('HTTP_X_QUERY_PARAMS' => JSON.generate({
+        upload('HTTP_X_JSON_PARAMS' => MultiJson.dump({
           :argument => 'value1',
           'argument with spaces' => 'value 2'
         }))
@@ -210,6 +215,43 @@ class RawUploadTest < Test::Unit::TestCase
       end
     end
 
+    context "with query parameters" do
+      setup do
+        upload('HTTP_X_PARAMS' => "arg=val1&ar+g=val2")
+      end
+
+      should "convert these into arguments" do
+        assert_equal last_request.POST['arg'], 'val1'
+        assert_equal last_request.POST['ar g'], 'val2'
+      end
+    end
+
+    context "with query parameters, deprecated style" do
+      setup do
+        json_params = MultiJson.dump({
+          :argument => 'value1',
+          'argument with spaces' => 'value 2'
+        })
+        @mock_error_stream = obj = Object.new
+        stub(obj).puts
+        stub(obj).flush
+
+        upload({
+          'HTTP_X_QUERY_PARAMS' => json_params,
+          'rack.errors' => @mock_error_stream
+        })
+      end
+
+      should "convert these into arguments" do
+        assert_equal last_request.POST['argument'], 'value1'
+        assert_equal last_request.POST['argument with spaces'], 'value 2'
+      end
+
+      should "give a deprecation warning" do
+        assert_received(@mock_error_stream) {|subject| subject.puts(is_a(String)) }
+      end
+    end
+
     context "with filename" do
       setup do
         upload('HTTP_X_FILE_NAME' => @filename)

metadata

@@ -1,78 +1,72 @@
 --- !ruby/object:Gem::Specification 
 name: rack-raw-upload
 version: !ruby/object:Gem::Version 
-  hash: 1
   prerelease: 
-  segments: 
-  - 1
-  - 0
-  - 11
-  version: 1.0.11
+  version: 1.1.1
 platform: ruby
 authors: 
-- Pablo Brasero
+  - Pablo Brasero
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2011-11-23 00:00:00 Z
+date: 2013-01-06 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"
-  type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rake
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rack-test
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: shoulda
-  prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  version_requirements: *id004
+  - !ruby/object:Gem::Dependency 
+    name: multi_json
+    prerelease: false
+    requirement: &id001 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :runtime
+    version_requirements: *id001
+  - !ruby/object:Gem::Dependency 
+    name: rake
+    prerelease: false
+    requirement: &id002 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :development
+    version_requirements: *id002
+  - !ruby/object:Gem::Dependency 
+    name: rack-test
+    prerelease: false
+    requirement: &id003 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :development
+    version_requirements: *id003
+  - !ruby/object:Gem::Dependency 
+    name: shoulda
+    prerelease: false
+    requirement: &id004 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :development
+    version_requirements: *id004
+  - !ruby/object:Gem::Dependency 
+    name: rr
+    prerelease: false
+    requirement: &id005 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :development
+    version_requirements: *id005
 description: Middleware that converts files uploaded with mimetype application/octet-stream into normal form input, so Rack applications can read these as normal, rather than as raw input.
 email: pablobm@gmail.com
 executables: []
@@ -80,71 +74,66 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- LICENSE
-- README.md
+  - LICENSE
+  - README.md
 files: 
-- lib/rack/raw_upload.rb
-- lib/rack-raw-upload.rb
-- test/apps/undefined_conversion_error/app/controllers/application_controller.rb
-- test/apps/undefined_conversion_error/app/controllers/test_controller.rb
-- test/apps/undefined_conversion_error/app/helpers/application_helper.rb
-- test/apps/undefined_conversion_error/config/application.rb
-- test/apps/undefined_conversion_error/config/boot.rb
-- test/apps/undefined_conversion_error/config/environment.rb
-- test/apps/undefined_conversion_error/config/environments/development.rb
-- test/apps/undefined_conversion_error/config/environments/production.rb
-- test/apps/undefined_conversion_error/config/environments/test.rb
-- test/apps/undefined_conversion_error/config/initializers/backtrace_silencers.rb
-- test/apps/undefined_conversion_error/config/initializers/inflections.rb
-- test/apps/undefined_conversion_error/config/initializers/mime_types.rb
-- test/apps/undefined_conversion_error/config/initializers/secret_token.rb
-- test/apps/undefined_conversion_error/config/initializers/session_store.rb
-- test/apps/undefined_conversion_error/config/initializers/wrap_parameters.rb
-- test/apps/undefined_conversion_error/config/routes.rb
-- test/apps/undefined_conversion_error/db/seeds.rb
-- test/apps/undefined_conversion_error/test/performance/browsing_test.rb
-- test/apps/undefined_conversion_error/test/test_helper.rb
-- test/raw_upload_test.rb
-- LICENSE
-- README.md
-- Gemfile
-- Gemfile.lock
+  - lib/rack-raw-upload.rb
+  - lib/rack/raw_upload.rb
+  - test/raw_upload_test.rb
+  - test/apps/example/app.rb
+  - test/apps/example/lib/simple_app.rb
+  - test/apps/undefined_conversion_error/app/controllers/application_controller.rb
+  - test/apps/undefined_conversion_error/app/controllers/test_controller.rb
+  - test/apps/undefined_conversion_error/app/helpers/application_helper.rb
+  - test/apps/undefined_conversion_error/config/application.rb
+  - test/apps/undefined_conversion_error/config/boot.rb
+  - test/apps/undefined_conversion_error/config/environment.rb
+  - test/apps/undefined_conversion_error/config/routes.rb
+  - test/apps/undefined_conversion_error/config/environments/development.rb
+  - test/apps/undefined_conversion_error/config/environments/production.rb
+  - test/apps/undefined_conversion_error/config/environments/test.rb
+  - test/apps/undefined_conversion_error/config/initializers/backtrace_silencers.rb
+  - test/apps/undefined_conversion_error/config/initializers/inflections.rb
+  - test/apps/undefined_conversion_error/config/initializers/mime_types.rb
+  - test/apps/undefined_conversion_error/config/initializers/secret_token.rb
+  - test/apps/undefined_conversion_error/config/initializers/session_store.rb
+  - test/apps/undefined_conversion_error/config/initializers/wrap_parameters.rb
+  - test/apps/undefined_conversion_error/db/seeds.rb
+  - test/apps/undefined_conversion_error/test/test_helper.rb
+  - test/apps/undefined_conversion_error/test/performance/browsing_test.rb
+  - LICENSE
+  - README.md
+  - Gemfile
+  - Gemfile.lock
 homepage: https://github.com/newbamboo/rack-raw-upload
 licenses: []
 
 post_install_message: 
 rdoc_options: 
-- --charset=UTF-8
-- --main
-- README.rdoc
+  - --charset=UTF-8
+  - --main
+  - README.rdoc
 require_paths: 
-- lib
+  - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.15
 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: 
+  - test/apps/undefined_conversion_error/app/controllers/test_controller.rb
+  - test/apps/undefined_conversion_error/test/test_helper.rb