rack-strip_http_accept_headers 0.1.0

data/README.mdown

@@ -0,0 +1,23 @@
+# Rack middleware to strip HTTP accept headers
+
+Strips HTTP_ACCEPT headers for all non XML HTTP requests
+
+HTTP accept headers are generally implemented in such a broken way in the
+wild, see http://www.gethifi.com/blog/browser-rest-http-accept-headers that
+unless you really need them it is best to ignore them.
+
+## FAQ
+
+1. Why keep the HTTP accept headers for XML HTTP requests?
+
+   XML HTTP requests are often made from the javascript you have placed in web pages. In these cases you control the accept headers that are sent with the requests and so it is neat to be able to make use of these for content negotiation, so we leave them in.
+
+2. I want to turn off content negotiation entirely?
+
+   If you are using Rails v3.1 or greater and you want to turn off content negotiation entirely with
+
+     ```ActionDispatch::Request.ignore_accept_header = true```
+
+   Once you have done this HTTP accept header values will be ignored.
+
+ 

data/lib/rack/strip_http_accept_headers.rb

@@ -0,0 +1,20 @@
+require 'rack'
+
+module Rack
+  # Strips HTTP_ACCEPT headers for all non XML HTTP requests
+  #
+  # HTTP_ACCEPT headers are generally implemented in such a broken way in the
+  # wild, see http://www.gethifi.com/blog/browser-rest-http-accept-headers that
+  # unless you really need them it is best to ignore them.
+  class StripHttpAcceptHeaders
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      env.delete('HTTP_ACCEPT') unless Rack::Request.new(env).xhr?
+      @app.call(env)
+    end
+  end
+end
+

data/spec/lib/rack/strip_http_accept_headers_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe Rack::StripHttpAcceptHeaders do
+  let(:app) do
+    Rack::Builder.new {
+      use Rack::StripHttpAcceptHeaders
+      run lambda {|env| [200, {'Content-Type' => 'text/html'}, ['']] }
+    }.to_app
+  end
+
+  def get(path, opts={})
+    env = Rack::MockRequest.env_for(path, opts)
+    app.call(env)
+    env
+  end
+
+  describe 'non XHR' do
+    it 'should strip HTTP_ACCEPT headers' do
+      get('/path/resource.html',
+          'HTTP_ACCEPT' => 'application/xml')['HTTP_ACCEPT'].
+        should be_nil
+    end
+  end
+
+  describe 'XHR' do
+    it 'should not strip HTTP_ACCEPT headers' do
+      get('/path/resource.html',
+          'HTTP_ACCEPT'           => 'application/xml',
+          'HTTP_X_REQUESTED_WITH' => 'XMLHttpRequest')['HTTP_ACCEPT'].
+        should == 'application/xml'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'rack/strip_http_accept_headers'

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: rack-strip_http_accept_headers
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Joel Chippindale
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: &70264151741960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70264151741960
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70264151738120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: *70264151738120
+description: 
+email: joel.chippindale@econsultancy.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.mdown
+files:
+- README.mdown
+- spec/lib/rack/strip_http_accept_headers_spec.rb
+- spec/spec_helper.rb
+- lib/rack/strip_http_accept_headers.rb
+homepage: http://github.com/econsultancy/rack-strip_http_accept_headers
+licenses: []
+post_install_message: 
+rdoc_options:
+- --main
+- README.mdown
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1068922097598369268
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Rack middleware to strip accept headers from non XHR requests
+test_files: []