rack-raw-upload 1.0.11 → 1.1.0

data/Gemfile

@@ -6,4 +6,5 @@ group :development, :test do
   gem 'rake'
   gem 'rack-test'
   gem 'shoulda'
+  gem 'rr'
 end

data/Gemfile.lock

@@ -7,6 +7,7 @@ GEM
     rack-test (0.5.6)
       rack (>= 1.0)
     rake (0.8.7)
+    rr (1.0.4)
     shoulda (2.11.3)
 
 PLATFORMS
@@ -17,4 +18,5 @@ DEPENDENCIES
   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

@@ -3,7 +3,7 @@ require 'tmpdir' # Needed in 1.8.7 to access Dir::tmpdir
 module Rack
   class RawUpload
 
-    VERSION = '1.0.11'
+    VERSION = '1.1.0'
 
     def initialize(app, opts = {})
       @app = app
@@ -57,11 +57,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 +105,19 @@ module Rack
     def random_string
       (0...8).map{65.+(rand(25)).chr}.join
     end
+
+    def inject_json_params!(env, params)
+      require 'json'
+      hsh = JSON.parse(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,17 @@
+require 'pp'
+require 'sinatra/base'
+
+class SimpleApp < Sinatra::Base
+
+  set :root, APP_ROOT
+  set :static, true
+
+  get '/' do
+    erb :index
+  end
+
+  post '/' do
+    Rack::Utils.escape_html(PP.pp(params, ''))
+  end
+
+end

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

@@ -0,0 +1,44 @@
+require 'httparty'
+
+class TflCountdown
+  include HTTParty
+  base_uri 'http://countdown.tfl.gov.uk'
+
+  def initialize(status = {})
+    @cookies = status['cookies'] if status['cookies']
+  end
+
+  def search(q)
+    get_json('/search', 'searchTerm' => q)
+  end
+
+  def markers(swlat, swlng, nelat, nelng)
+    path = "/markers/swLat/#{swlat}/swLng/#{swlng}/neLat/#{nelat}/neLng/#{nelng}/"
+    get_json(path)
+  end
+
+
+  def get_json(path, query = {})
+    query_params = {
+      '_dc' => Time.now.to_i,
+    }.merge(query)
+
+    headers = {
+      'X-Requested-With' => 'XMLHttpRequest',
+      'Referer' => 'http://countdown.tfl.gov.uk/',
+      'User-Agent' => 'Pablito\'s own',
+    }
+    headers['Cookie'] = @cookies if @cookies
+
+    res = self.class.get(path, :query => query_params, :headers => headers, :format => :json)
+    @cookies = res.headers['set-cookie']
+    res.body
+  end
+
+  def to_hash
+    ret = {}
+    ret['cookies'] = @cookies if @cookies
+    ret
+  end
+
+end

data/test/raw_upload_test.rb

@@ -4,9 +4,11 @@ require 'shoulda'
 require 'rack-raw-upload'
 require '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
@@ -196,9 +196,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' => JSON.generate({
           :argument => 'value1',
           'argument with spaces' => 'value 2'
         }))
@@ -210,6 +210,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 = JSON.generate({
+          :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,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: rack-raw-upload
 version: !ruby/object:Gem::Version 
-  hash: 1
-  prerelease: 
+  prerelease: false
   segments: 
   - 1
+  - 1
   - 0
-  - 11
-  version: 1.0.11
+  version: 1.1.0
 platform: ruby
 authors: 
 - Pablo Brasero
@@ -15,17 +14,16 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-23 00:00:00 Z
+date: 2012-04-24 00:00:00 +01:00
+default_executable: 
 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"
@@ -35,11 +33,9 @@ dependencies:
   name: rake
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
@@ -49,11 +45,9 @@ 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"
@@ -63,11 +57,9 @@ dependencies:
   name: shoulda
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
@@ -85,6 +77,9 @@ extra_rdoc_files:
 files: 
 - lib/rack/raw_upload.rb
 - lib/rack-raw-upload.rb
+- test/apps/example/app.rb
+- test/apps/example/lib/simple_app.rb
+- test/apps/example/lib/tfl_countdown.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
@@ -109,6 +104,7 @@ files:
 - README.md
 - Gemfile
 - Gemfile.lock
+has_rdoc: true
 homepage: https://github.com/newbamboo/rack-raw-upload
 licenses: []
 
@@ -120,31 +116,26 @@ 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.8.10
+rubygems_version: 1.3.6
 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: