Merge pull request #26 from duncanbeevers/middleware

tors · tors · commit 331ff48e2faa · 2012-12-06T04:43:43.000-08:00
Add X-Requested-With param and IFrame middleware
diff --git a/README.md b/README.md
@@ -48,6 +48,12 @@ Require the stylesheet file to app/assets/stylesheets/application.css
 
     *= require jquery.fileupload-ui
 
+## Using the middleware
+
+The `jquery.iframe-transport` fallback transport has some special caveats regarding the response data type, http status, and character encodings. `jquery-fileupload-rails` includes a middleware that handles these inconsistencies seamlessly. If you decide to use it, create an initializer that adds the middleware to your application's middleware stack.
+
+    Rails.application.config.middleware.use JQuery::FileUpload::Rails::Middleware
+
 ## [Example app](https://github.com/tors/jquery-fileupload-rails-paperclip-example)
 This app uses paperclip and twitter-bootstrap-rails
 
diff --git a/lib/jquery/fileupload/rails/middleware.rb b/lib/jquery/fileupload/rails/middleware.rb
@@ -0,0 +1,59 @@
+module JQuery
+  module FileUpload
+    module Rails
+      class Middleware
+        def initialize(app)
+          @app = app
+        end
+
+        def call(env)
+          dup._call(env)
+        end
+
+        def _call(env)
+          @status, @headers, @response = @app.call(env)
+          @request = Rack::Request.new(env)
+
+          if iframe_transport?
+            @headers['Content-Type'] = 'text/html'
+            [@status, @headers, self]
+          else
+            [@status, @headers, @response]
+          end
+        end
+
+        def each(&block)
+          block.call(html_document_left) if iframe_transport?
+          @response.each(&block)
+          block.call(html_document_right) if iframe_transport?
+        end
+
+        def iframe_transport?
+          @request.params['X-Requested-With'] == 'IFrame'
+        end
+
+        def html_document_left
+          "<!DOCTYPE html><html><body><textarea #{metadata}>"
+        end
+
+        def html_document_right
+          "</textarea></body></html>"
+        end
+
+        def metadata
+          meta = {}
+          meta['data-status'] = @response.status if @response.respond_to? :status
+          meta['data-statusText'] = @response.status_message if @response.respond_to? :status_message
+          meta['data-type'] = @headers['Content-Type'] if @headers.has_key?('Content-Type')
+          meta.map {|key,value| "#{key}='#{value}'" }.join(' ')
+        end
+
+        private
+
+        def method_missing(method, *args)
+          @response.send(method.intern, *args)
+        end
+      end
+    end
+  end
+end
diff --git a/lib/jquery/fileupload/rails/upload.rb b/lib/jquery/fileupload/rails/upload.rb
@@ -1,2 +1,3 @@
 require "jquery/fileupload/rails/engine"
 require "jquery/fileupload/rails/version"
+require "jquery/fileupload/rails/middleware"
diff --git a/vendor/assets/javascripts/jquery-fileupload/jquery.iframe-transport.js b/vendor/assets/javascripts/jquery-fileupload/jquery.iframe-transport.js
@@ -96,6 +96,13 @@
                                     .val(field.value)
                                     .appendTo(form);
                             });
+                            // Add a hidden `X-Requested-With` field with the value `IFrame` to the
+                            // form, to help server-side code to determine that the upload happened
+                            // through this transport.
+                            $('<input type="hidden" />')
+                                .prop('name', 'X-Requested-With')
+                                .val('IFrame')
+                                .appendTo(form);
                         }
                         if (options.fileInput && options.fileInput.length &&
                                 options.type === 'POST') {

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,3 @@`
`1`	`1`	`require "jquery/fileupload/rails/engine"`
`2`	`2`	`require "jquery/fileupload/rails/version"`
	`3`	`+require "jquery/fileupload/rails/middleware"`