mynyml-rack-supported-media-types 0.8 → 0.9

data/README

@@ -0,0 +1,60 @@
+===== Summary
+
+Rack middleware to specify an app's supported media types.
+Returns '415 Unsuported Media Type' status when unsuported type is requested.
+
+The requested type is assumed to be the first content-type in the Accept header's list.
+
+===== Example
+
+  require 'rack'
+  require 'rack/supported_media_types'
+
+  use Rack::SupportedMediaTypes, %w( application/xml application/json )
+  run App.new
+
+will give you:
+
+  GET /foo
+  Accept: text/html,text/plain
+  #=> 415 Unsupported Media Type
+
+  GET /foo
+  Accept: application/xml,text/html
+  #=> 200 OK
+
+  GET /foo
+  Accept: application/json,text/html
+  #=> 200 OK
+
+see examples/simple.ru for example code.
+
+===== Tip
+
+To read the requested type from the url's extension instead of the Accept
+header (which is a more realistic use case), use Rack::AbstractFormat before
+Rack::SupportedMediaTypes.
+
+  require 'rack'
+  require 'rack/abstract_format'
+  require 'rack/supported_media_types'
+
+  use Rack::AbstractFormat
+  use Rack::SupportedMediaTypes, %w( application/xml application/json )
+  run App.new
+
+will result in:
+
+  GET /foo.html
+  #=> 415 Unsupported Media Type
+
+  GET /foo.xml
+  #=> 200 OK
+
+  GET /foo.json
+  #=> 200 OK
+
+(Rack::AbstractFormat prepends the media type for the url's extension to the
+Accept header)
+
+see examples/recommended.ru for example code.

data/Rakefile

@@ -22,7 +22,7 @@ end
 
 spec = Gem::Specification.new do |s|
   s.name            = 'rack-supported-media-types'
-  s.version         = '0.8'
+  s.version         = '0.9'
   s.summary         = "Rack middleware to specify an app's supported media types."
   s.description     = "Rack middleware to specify an app's supported media types. Returns '415 Unsuported Media Type' status when unsuported type is requested."
   s.author          = "Martin Aumont"

data/examples/recommended.ru

@@ -0,0 +1,34 @@
+# run me with:
+#   $rackup examples/recommended.ru -p 3000
+#
+require 'pathname'
+require 'rubygems'
+require 'rack'
+require 'rack/abstract_format'
+
+root = Pathname(__FILE__).dirname.parent.expand_path
+require root + 'lib/rack/supported_media_types'
+
+class App
+  def call(env)
+    body = <<-BODY
+<pre>
+try using extensions:
+
+  - /foo.html
+  - /foo.xml
+  - /foo.json
+  - /foo.txt
+  - ...
+
+app will only accept .html and .xml requests. others will return 415
+(check server's output in console to see it)
+</pre>
+    BODY
+    [200, {'Content-Type' => 'text/html'}, [body]]
+  end
+end
+
+use Rack::AbstractFormat
+use Rack::SupportedMediaTypes, %w( text/html application/xml )
+run App.new

data/examples/simple.ru

@@ -0,0 +1,37 @@
+# run me with:
+#   $rackup examples/simple.ru -p 3000
+#
+# then point your browser to:
+#   localhost:3000/
+#   localhost:3000/foo
+#
+# and look for the server's output in the console (pay attention to status
+# codes)
+#
+require 'pathname'
+require 'rubygems'
+require 'rack'
+
+root = Pathname(__FILE__).dirname.parent.expand_path
+require root + 'lib/rack/supported_media_types'
+
+class App
+  def call(env)
+    [200, {'Content-Type' => 'text/html'}, ['now try <strong>/foo</strong> (will return 415)']]
+  end
+end
+
+# given that the request comes from a webbrowser, and that it's Accept header's
+# first value is text/html...
+
+map '/' do
+  # ... this will allow it through to the app
+  use Rack::SupportedMediaTypes, %w( text/html application/xml )
+  run App.new
+end
+
+map '/foo' do
+  # ... this will abort the request and return 415 Unsupported Media Type
+  use Rack::SupportedMediaTypes, %w( application/xml application/json )
+  run App.new
+end

data/lib/rack/supported_media_types.rb

@@ -1,24 +1,25 @@
 module Rack
   class SupportedMediaTypes
+
     def initialize(app, mime_types)
       @app, @mime_types = app, mime_types
     end
 
+    #--
+    # return any headers with 415?
     def call(env)
-      type = requested_mime_type(env)
-      if @mime_types.include?(type)
-        @app.call(env)
-      else
+      @mime_types.include?(accept(env)) ?
+        @app.call(env) :
         Rack::Response.new([], 415).finish
-      end
     end
 
-    def requested_mime_type(env)
-      format = env['request.format']
-
-      Rack::Mime::MIME_TYPES.values.include?(format) ?
-        format :
-        Rack::Mime.mime_type(format.sub(/^\./,'').insert(0,'.'), nil)
-    end
+    private
+      #--
+      # First content-type in Accept header's list, without params
+      def accept(env)
+        if env['HTTP_ACCEPT'] && !env['HTTP_ACCEPT'].empty?
+           env['HTTP_ACCEPT'].split(',').first.split(';').first
+        end
+      end
   end
 end

data/rack-supported-media-types.gemspec

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: rack-supported-media-types
+version: !ruby/object:Gem::Version 
+  version: "0.9"
+platform: ruby
+authors: 
+- Martin Aumont
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-04 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Rack middleware to specify an app's supported media types. Returns '415 Unsuported Media Type' status when unsuported type is requested.
+email: mynyml@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- test
+- test/test_supported_media_types.rb
+- test/test_helper.rb
+- examples
+- examples/simple.ru
+- examples/recommended.ru
+- lib
+- lib/rack
+- lib/rack/supported_media_types.rb
+- LICENSE
+- rack-supported-media-types.gemspec
+- README
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.3
+signing_key: 
+specification_version: 3
+summary: Rack middleware to specify an app's supported media types.
+test_files: []
+

data/test/test_helper.rb

@@ -2,9 +2,9 @@ require 'pathname'
 require 'test/unit'
 require 'rubygems'
 require 'rack'
-require 'phocus/test_unit'
 begin
   require 'ruby-debug'
+  require 'phocus/test_unit'
 rescue LoadError, RuntimeError
 end
 

data/test/test_supported_media_types.rb

@@ -1,49 +1,58 @@
 require 'test/test_helper'
 
-InnerApp = Rack::Builder.new {
-  use Rack::Lint
-  run lambda {|env| [200, {'Content-Type' => 'text/html'}, ['content']] }
-}.to_app
+App = lambda {|env| [200, {'Content-Type' => 'text/html'}, ['content']] }
+SMT = Rack::SupportedMediaTypes
 
-class SupportedMediaTypeTest < Test::Unit::TestCase
+class SupportedMediaTypesTest < Test::Unit::TestCase
 
   test "returns 415 Unsuported Media Type" do
-    app = Rack::Builder.new {
-      use Rack::SupportedMediaTypes, %w( application/xml text/html )
-      run InnerApp
-    }.to_app
-
-    client = Rack::MockRequest.new(app)
-    response = client.get('/', 'request.format' => '.txt')
+    app = SMT.new(App, %w( application/xml application/json ))
 
+    response = Rack::MockRequest.new(app).get('/', 'HTTP_ACCEPT' => 'text/html')
     assert_equal 415, response.status
     assert response.body.empty?
   end
 
   test "lets request through when media type is supported" do
-    app = Rack::Builder.new {
-      use Rack::SupportedMediaTypes, %w( text/plain application/xml )
-      run InnerApp
-    }.to_app
-
-    client = Rack::MockRequest.new(app)
-    response = client.get('/', 'request.format' => '.txt')
+    app = SMT.new(App, %w( text/html application/xml ))
 
+    response = Rack::MockRequest.new(app).get('/', 'HTTP_ACCEPT' => 'text/html')
     assert_equal 200, response.status
   end
 
-  test "normalizes request format" do
-    app = Rack::Builder.new {
-      use Rack::SupportedMediaTypes, %w( text/html )
-      run InnerApp
-    }.to_app
-
+  test "requested type is assumed to be first type in Accept header's list" do
+    app = SMT.new(App, %w( text/html ))
     client = Rack::MockRequest.new(app)
 
-    response = client.get('/', 'request.format' => 'html')
+    response = client.get('/', 'HTTP_ACCEPT' => 'text/html,application/xml')
     assert_equal 200, response.status
 
-    response = client.get('/', 'request.format' => 'text/html')
+    response = client.get('/', 'HTTP_ACCEPT' => 'application/xml,text/html')
+    assert_equal 415, response.status
+  end
+
+  test "ignores content-type params" do
+    app = SMT.new(App, %w( application/xml application/json ))
+
+    response = Rack::MockRequest.new(app).get('/', 'HTTP_ACCEPT' => 'application/xml;q=0.9')
     assert_equal 200, response.status
   end
+
+  test "nil Accept header" do
+    app = SMT.new(App, %w( application/xml application/json ))
+
+    assert_nothing_raised do
+      response = Rack::MockRequest.new(app).get('/', 'HTTP_ACCEPT' => nil)
+      assert_equal 415, response.status
+    end
+  end
+
+  test "empty Accept header" do
+    app = SMT.new(App, %w( application/xml application/json ))
+
+    assert_nothing_raised do
+      response = Rack::MockRequest.new(app).get('/', 'HTTP_ACCEPT' => '')
+      assert_equal 415, response.status
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mynyml-rack-supported-media-types
 version: !ruby/object:Gem::Version 
-  version: "0.8"
+  version: "0.9"
 platform: ruby
 authors: 
 - Martin Aumont
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-01 21:00:00 -07:00
+date: 2009-06-03 21:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -26,10 +26,14 @@ files:
 - test
 - test/test_supported_media_types.rb
 - test/test_helper.rb
+- examples
+- examples/simple.ru
+- examples/recommended.ru
 - lib
 - lib/rack
 - lib/rack/supported_media_types.rb
 - LICENSE
+- rack-supported-media-types.gemspec
 - README
 has_rdoc: true
 homepage: ""