rack-content_type_validator 0.0.1

data/README.md

@@ -0,0 +1,59 @@
+# Rack Content-Type Validator middleware
+
+Rack::ContentTypeValidator it's a **rack middleware** to validate the header **Content-Type** of requests.
+
+## What does it do?
+
+When a ruby webserver receives a request, it validates the Content-Type. Whenever validation fails, the middleware sends a response to client with 415 (Unsupported Media Type) HTTP error.
+    
+## Usage
+
+### Rails apps
+
+In your Gemfile:
+ 
+    gem 'rack-content_type_validator'
+In your environment.rb:
+
+    require 'rack/content_type_validator'
+    config.middleware.use Rack::ContentTypeValidator
+
+### Non-Rails apps
+
+Just 'use Rack::ContentTypeValidator' as any other middleware.
+
+## Configuration Examples
+
+#### POST requests at the path '/posts' should be 'application/json':
+    config.middleware.use Rack::ContentTypeValidator, :post, '/posts', {:mime_type => "application/json"}
+
+#### POST and PUT requests at the path '/users' should be 'application/json':
+    config.middleware.use Rack::ContentTypeValidator, [:post, :put], '/users', {:mime_type => "application/json"}
+
+#### POST requests at the path '/pages' should be 'application/xml' with charset UTF-8:
+    config.middleware.use Rack::ContentTypeValidator, :post, '/pages', {:mime_type => "application/xml", :charset => "UTF-8"}
+
+#### PUT requests at the path '/pages' should have charset ISO-8859-1:
+    config.middleware.use Rack::ContentTypeValidator, :put, '/pages', {:charset => "ISO-8859-1"}
+
+#### You can pass a Regexp on path:
+    config.middleware.use Rack::ContentTypeValidator, :put, /\/pages\/.+/, {:charset => "ISO-8859-1"}
+    
+#### You can configure more the one:
+    config.middleware.use Rack::ContentTypeValidator, :post, '/posts', {:mime_type => "application/json"}
+    config.middleware.use Rack::ContentTypeValidator, :put, /\/posts\/.+/, {:mime_type => "application/json"}
+
+## Report bugs and suggestions
+
+  * [Issue Tracker](http://github.com/abril/rack-content_type_validator/issues)
+
+## Authors
+
+ * [Lucas Fais](http://github.com/lucasfais)
+ * [Marcelo Manzan](http://github.com/kawamanza)
+ 
+## References
+
+ * [RFC 2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17)
+ * [Rails on Rack](http://guides.rubyonrails.org/rails_on_rack.html)
+ 

data/Rakefile

@@ -0,0 +1,26 @@
+require 'rake/testtask'
+
+task :default => :test
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end
+
+desc "Build the gem"
+task :build do
+  opers = Dir.glob('*.gem')
+  opers = ["rm #{ opers.join(' ') }"] unless opers.empty?
+  opers << ["gem build rack-content_type_validator.gemspec"]
+  sh opers.join(" && ")
+end
+
+desc "Build and install the gem, removing old installation"
+task :install => :build do
+  gem = Dir.glob('*.gem').first
+  if gem.nil?
+    puts "could not install the gem"
+  else
+    sh "gem uninstall rack-content_type_validator; gem install #{ gem }"
+  end
+end

data/lib/rack/content_type_validator/version.rb

@@ -0,0 +1,12 @@
+module Rack
+  class ContentTypeValidator
+    version = nil
+    version = $1 if ::File.expand_path('../../..', __FILE__) =~ /\/rack-content_type_validator-([\w\.\-]+)/
+    if version.nil? && ::File.exists?(::File.expand_path('../../../../.git', __FILE__))
+      require "step-up"
+      version = StepUp::Driver::Git.last_version
+    end
+    version = "0.0.0" if version.nil?
+    VERSION = version.gsub(/^v?([^\+]+)\+?\d*$/, '\1')
+  end
+end

data/lib/rack/content_type_validator.rb

@@ -0,0 +1,66 @@
+require 'json'
+
+module Rack
+  class ContentTypeValidator
+    autoload :VERSION, 'rack/content_type_validator/version.rb'
+
+    def initialize(app, methods, path, expected_params)
+      @app = app
+      @methods = handle_methods(methods)
+      @path = path
+      @expected_params = expected_params
+    end
+
+    def call(env)
+      if match_path?(env['PATH_INFO']) && match_method?(env['REQUEST_METHOD'])
+        content_type = env['CONTENT_TYPE']
+        
+        unless valid_content_type?(content_type) && valid_charset?(content_type)
+          response = Response.new
+          response.status = 415
+          response.write(error_message)
+          response.headers["Content-Type"] = 'text/plain'
+          
+          return response.finish
+        end
+      end
+
+      @app.call(env)
+    end
+
+    private
+      def handle_methods(methods)
+        methods = methods.is_a?(Array) ? methods : [methods]
+        methods.collect {|m| m.to_s.upcase}
+      end
+      
+      def match_path?(path)
+        @path.is_a?(Regexp) ? @path.match(path.to_s) : @path == path.to_s
+      end
+
+      def match_method?(method)
+        @methods.empty? || @methods.include?(method)
+      end
+      
+      def valid_content_type?(content_type)
+        return true unless @expected_params[:mime_type]
+        
+        type_and_subtype = content_type ? content_type[/^([\w\/]+)\b/, 1] : nil
+        type_and_subtype == @expected_params[:mime_type]
+      end
+      
+      def valid_charset?(content_type)
+        return true unless @expected_params[:charset]
+        
+        charset = content_type ? content_type[/\bcharset=([^;\s]*)/, 1] : nil
+        charset.gsub!('"', '') if charset
+        charset == @expected_params[:charset]
+      end
+      
+      def error_message
+        charset = @expected_params[:charset] ? "; charset=#{@expected_params[:charset]}" : ""
+        message = "Unsupported Media Type. It should be like this: "
+        message += "\"#{@expected_params[:mime_type]}#{charset}\""
+      end
+  end
+end

data/rack-content_type_validator.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'rack/content_type_validator'
+
+Gem::Specification.new do |s|
+  s.name        = "rack-content_type_validator"
+  s.version     = Rack::ContentTypeValidator::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Lucas Fais"]
+  s.email       = ["lucasfais@gmail.com"]
+  s.homepage    = "http://github.com/abril/rack-content_type_validator"
+  s.summary     = %q{Makes easy to handle mutipart/related requests.}
+  s.description = %q{It's a rack middleware to parse multipart/related requests and rebuild a simple/merged parameters hash.}
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "rack-content_type_validator"
+
+  s.add_dependency "rack", '>= 1.0'
+  
+  s.add_development_dependency "step-up"
+
+  excepts = %w[
+    .gitignore
+    rack-multipart_related.gemspec
+  ]
+  tests = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.files              = `git ls-files`.split("\n") - excepts - tests
+  s.test_files         = tests
+  s.require_paths      = ["lib"]
+end

data/test/rack/content_type_validator_test.rb

@@ -0,0 +1,108 @@
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper.rb')
+
+class ContentTypeValidatorTest < Test::Unit::TestCase
+  
+  App = lambda { |env| [200, {'Content-Type' => 'text/plain'}, Rack::Request.new(env)] }
+  
+  def build_env(method, path, content_type)
+    env = Rack::MockRequest.env_for(path, {:method => method})
+    env["CONTENT_TYPE"] = content_type
+    env
+  end
+  
+  def build_middleware(methods, path, expected_params)
+    Rack::ContentTypeValidator.new(App, methods, path, expected_params)
+  end
+  
+  def test_request_in_other_paths
+    expected_params = {:mime_type => "application/xml"}
+    middleware = build_middleware(:put, "/other/path", expected_params)
+    
+    env = build_env("PUT", "/request_path", 'application/json')
+    status, headers, body = middleware.call(env)
+
+    assert_equal status, 200
+  end
+
+  def test_incorrect_content_type
+    path = "/users"
+
+    expected_params = {:mime_type => "application/xml"}
+    middleware = build_middleware([:put, :post], path, expected_params)
+    
+    env = build_env("PUT", path, 'application/json')
+    status, headers, body = middleware.call(env)
+
+    assert_equal status, 415
+  end
+  
+  def test_correct_content_type
+    path = "/posts"
+    
+    expected_params = {:mime_type => "application/json"}
+    middleware = build_middleware(:post, path, expected_params)
+    
+    env = build_env("POST", path, 'application/json')
+    status, headers, body = middleware.call(env)
+
+    assert_equal status, 200
+  end
+  
+  def test_correct_content_type_and_incorrect_charset
+    path = "/comments"
+    
+    expected_params = {:mime_type => "text/plain", :charset => "iso-8859-x"}
+    middleware = build_middleware(:post, path, expected_params)
+    
+    env = build_env("POST", path, 'text/plain; charset=us-ascii')
+    status, headers, body = middleware.call(env)
+
+    assert_equal status, 415
+  end
+  
+  def test_correct_content_type_and_charset
+    path = "/posts"
+    
+    expected_params = {:mime_type => "application/json", :charset => "UTF-8"}
+    middleware = build_middleware("POST", path, expected_params)
+    
+    env = build_env("POST", path, 'application/json; charset=UTF-8')
+    status, headers, body = middleware.call(env)
+
+    assert_equal status, 200
+  end
+  
+  def test_correct_content_type_and_charset_not_given
+    path = "/posts"
+    
+    expected_params = {:mime_type => "application/json"}
+    middleware = build_middleware([:post], path, expected_params)
+    
+    env = build_env("POST", path, 'application/json; charset=UTF-8')
+    status, headers, body = middleware.call(env)
+
+    assert_equal status, 200
+  end
+  
+  def test_regexp_on_path
+    expected_params = {:mime_type => "application/json", :charset => "UTF-8"}
+    middleware = build_middleware(:post, /comments/, expected_params)
+    
+    env = build_env("POST", "/content/1/comments", 'application/json; charset=UTF-8')
+    status, headers, body = middleware.call(env)
+
+    assert_equal status, 200
+  end
+  
+  def test_charset_with_quotes
+    expected_params = {:charset => "UTF-8"}
+    middleware = build_middleware(:post, /comments/, expected_params)
+    
+    env = build_env("POST", "/content/1/comments", 'application/xml; charset="UTF-8"')
+    status, headers, body = middleware.call(env)
+
+    assert_equal status, 200
+    
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'test/unit'
+require 'rack/mock'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rack/content_type_validator'
+
+begin
+  require "redgreen"
+  require "ruby-debug"
+rescue LoadError
+  # Not required gems.
+end
+

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification 
+name: rack-content_type_validator
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Lucas Fais
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-07 00:00:00 -02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: step-up
+  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
+description: It's a rack middleware to parse multipart/related requests and rebuild a simple/merged parameters hash.
+email: 
+- lucasfais@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.md
+- Rakefile
+- lib/rack/content_type_validator.rb
+- lib/rack/content_type_validator/version.rb
+- rack-content_type_validator.gemspec
+- test/rack/content_type_validator_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/abril/rack-content_type_validator
+licenses: []
+
+post_install_message: 
+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: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: rack-content_type_validator
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Makes easy to handle mutipart/related requests.
+test_files: 
+- test/rack/content_type_validator_test.rb
+- test/test_helper.rb